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

Class: AbstractMeasurementList


Abstract Class

    Abstract list of measurements. Different kinds of measurements belong to different kinsd of lists. All measurements belong to a list.

    NB All MeasurementLists have the attribute 'unit' (mandatory, datatype Word) giving the unit of measurement. For each kind of MeasurementList the unit will default to the recommended value.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrProject to class NmrProject
Main key: serial
Mandatory Attributes: unit
Known Subclasses: DipolarRelaxList, HExchProtectionList, HExchRateList, JCouplingList, NoeList, RdcList, ShiftAnisotropyList, ShiftDifferenceList, ShiftList, T1List, T1RhoList, T2List
Children:
link measurements to class AbstractMeasurement

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
isSimulated Boolean 1..1 Are data in this list simulated? The attribute is an annotation more than anything else, as there are no corresponding constraints.  
name Line 0..1 Measurement List name, freely chosen by user. Intended to identify the list from other lists of the same type.  
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  
unit Word 1..1 Unit of measurement for measurementList.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
entries ccp.api.nmr.NmrEntry.Entry 0..* Bmrb Entries for MeasurementList  
measurements AbstractMeasurement 0..* (Child link). child link to class AbstractMeasurement  
method ccp.api.general.Method.Method 0..1 Default method used to calculate measurements. May be overridden for individual measurements in the list.  
nmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation 0..* Validation results that include AbstractMeasurementList  
nmrProject NmrProject 1..1 (Parent link). parent link  
parent NmrProject 1..1 link to parent object - synonym for nmrProject  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
isSimulated
getIsSimulated Boolean -
setIsSimulated - Boolean
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
unit
getUnit Word -
setUnit - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
entries
getEntries ccp.api.nmr.NmrEntry.Entry Set -
setEntries - ccp.api.nmr.NmrEntry.Entry Set
sortedEntries ccp.api.nmr.NmrEntry.Entry List -
addEntry - ccp.api.nmr.NmrEntry.Entry
removeEntry - ccp.api.nmr.NmrEntry.Entry
findFirstEntry ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllEntries ccp.api.nmr.NmrEntry.Entry Set keyword=value pairs
measurements
getMeasurements AbstractMeasurement Set -
sortedMeasurements AbstractMeasurement List -
findFirstMeasurement AbstractMeasurement keyword=value pairs
findAllMeasurements AbstractMeasurement Set keyword=value pairs
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
nmrMeasurementListValidations
getNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation Set -
setNmrMeasurementListValidations - ccp.api.molecule.Validation.NmrMeasurementListValidation Set
sortedNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation List -
addNmrMeasurementListValidation - ccp.api.molecule.Validation.NmrMeasurementListValidation
removeNmrMeasurementListValidation - ccp.api.molecule.Validation.NmrMeasurementListValidation
findFirstNmrMeasurementListValidation ccp.api.molecule.Validation.NmrMeasurementListValidation keyword=value pairs
findAllNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation Set keyword=value pairs
nmrProject
getNmrProject NmrProject -
parent
getParent NmrProject -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
getByKey AbstractMeasurementList memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey 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_2006-08-16-14:22:46_00010

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: ccp.api.nmr.NmrCalc.MeasurementListData.measurementListccp.api.nmr.NmrConstraint.AbstractConstraintList.measurementLists
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:23 2014    from data model package  ccp.api.nmr.Nmr.AbstractMeasurementList   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk