Data Model version 2.1.2
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: Macro


    Command script for use in Analysis. Is assumed to be in Python.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link analysisProfile to class AnalysisProfile
Main key: serial
Mandatory Attributes: function, module, name
Known Subclasses: None
Children: None
Constructor: newObj = Macro( analysisProfile,function=value, module=value, name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details Text 0..1 Free text, for notes, explanatory comments, etc.  
function Word 1..1 Name of function to import  
isInMenu Boolean 1..1 Is macro shown in drop-down menu?  
isInMouseMenu Boolean 1..1 Is macro shown in right mouse menu?  
module Word 1..1 Name of module (optionally in dot separated form, like mod.submod.file) from which to import function.  
name Line 1..1 name of macro (used for ideitifying it to user).  
ordering Int 1..1 An integer that serves to order the different macros in lists (if, for instance you want to put the most commonly used ones at the top).  
path PathString 0..1 Directory to put on pythonpath in order to find file containing macro. Defaults to empty string, meaning that the directory is (assumed to be) already on the pythonpath.  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
shortcut Word 0..1 Keyboard shortcut to activate macro  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisProfile AnalysisProfile 1..1 (Parent link). parent link  
parent AnalysisProfile 1..1 link to parent object - synonym for analysisProfile  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails Text -
setDetails - Text
function
getFunction Word -
setFunction - Word
isInMenu
getIsInMenu Boolean -
setIsInMenu - Boolean
isInMouseMenu
getIsInMouseMenu Boolean -
setIsInMouseMenu - Boolean
module
getModule Word -
setModule - Word
name
getName Line -
setName - Line
ordering
getOrdering Int -
setOrdering - Int
path
getPath PathString -
setPath - PathString
serial
getSerial Int -
setSerial - Int
shortcut
getShortcut Word -
setShortcut - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProfile
getAnalysisProfile AnalysisProfile -
parent
getParent AnalysisProfile -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Macro memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2008-05-08-11:06:22_00001

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:15 2014    from data model package  ccpnmr.api.AnalysisProfile.Macro   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk