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

Class: AbstractModule


Abstract Class
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link analysisWindowStore to class AnalysisWindowStore
Main key: code
Mandatory Attributes: code
Known Subclasses: Module, Window
Children:
link parameters to class ModuleParameter

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 1..1 Code identifying the Module. Should be equal to the popup name for Modules, and to a window description string for Windows.  
details String 0..1 Free text, for notes, explanatory comments, etc.  
helpUrl Url 0..1 Url for Window help.  
keywords Line 0..* Keywords to classify and identify Module and its uses  
name Line 0..1 User-friendly module name.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisWindowStore AnalysisWindowStore 1..1 (Parent link). parent link  
parameters ModuleParameter 0..* (Child link). child link to class ModuleParameter  
parent AnalysisWindowStore 1..1 link to parent object - synonym for analysisWindowStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Word -
setCode - Word
details
getDetails String -
setDetails - String
helpUrl
getHelpUrl Url -
setHelpUrl - Url
keywords
getKeywords Line Tuple -
setKeywords - Line List
addKeyword - Line
removeKeyword - Line
name
getName Line -
setName - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisWindowStore
getAnalysisWindowStore AnalysisWindowStore -
parameters
getParameters ModuleParameter Set -
sortedParameters ModuleParameter List -
findFirstParameter ModuleParameter keyword=value pairs
findAllParameters ModuleParameter Set keyword=value pairs
parent
getParent AnalysisWindowStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
getByKey AbstractModule memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -

Factory Methods (in package)

Go to Top
Method Return Parameters
newModuleParameter ModuleParameter name, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2011-11-16-17:07:15_00004

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: ccpnmr.api.AnalysisLayout.AbstractPanel.module
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:33 2015    from data model package  ccpnmr.api.AnalysisWindow.AbstractModule   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk