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

Class: ParameterGroup


    Group of parameters that belong together. Could serve e.g. to group parameters for successive phases of an annealing protocol.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link run to class Run
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = ParameterGroup( run, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 0..1 Unique identifier for the parameter within the context of the application being run  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
ioRole IoRole 1..1 Role of data in calculation (input / output).  
name Line 0..1 Human readable name of parameter  
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  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
data Data 0..* Data that are grouped in ParameterGroup  
parameterGroup ParameterGroup 0..1 Parameter group that Data belong to  
parent Run 1..1 link to parent object - synonym for run  
run Run 1..1 (Parent link). parent link  
runParameters RunParameter 0..* parameters that refer to unit of data.  

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 Text -
setDetails - Text
ioRole
getIoRole IoRole -
setIoRole - IoRole
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
data
getData Data Set -
setData - Data Set
sortedData Data List -
addData - Data
removeData - Data
findFirstData Data keyword=value pairs
findAllData Data Set keyword=value pairs
parameterGroup
getParameterGroup ParameterGroup -
setParameterGroup - ParameterGroup
parent
getParent Run -
run
getRun Run -
runParameters
getRunParameters RunParameter Set -
setRunParameters - RunParameter Set
sortedRunParameters RunParameter List -
addRunParameter - RunParameter
removeRunParameter - RunParameter
findFirstRunParameter RunParameter keyword=value pairs
findAllRunParameters RunParameter Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ParameterGroup 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_2011-10-11-16:36:17_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  Mon Mar 2 17:25:13 2015    from data model package  ccp.api.nmr.NmrCalc.ParameterGroup   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk