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

Class: AbstractMeasurement


Abstract Class

    NMR parameter value (e.g. Chemical Shift, Coupling Constant, TROESY shift, MQ frequency, or in general any measured result associated with one or more Resonances (and through them with Atoms).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link parentList to class AbstractMeasurementList
Main key: n/a
Mandatory Attributes: value
Known Subclasses: DipolarRelaxation, HExchProtection, HExchRate, JCoupling, Noe, Rdc, Shift, ShiftAnisotropy, ShiftDifference, T1, T1Rho, T2
Children: None

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details Text 0..1 Free text, for notes, explanatory comments, etc.  
error Float 1..1 Error (standard deviation) of measurement  
figOfMerit FloatRatio 1..1 Figure of Merit for measurement, i.e. a number that describes the reliablity. Goes from 1.0 (fully reliable, the default), to 0.0 (unreliable).  
value Float 1..1 Value of measurement  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataDerivations AbstractDataDerivation 0..* Data Derivations where Measurement is used.  
method ccp.api.general.Method.Method 0..1 Method used to calculate this specific measurment value. Overrides MeasurementList.method  
nmrMeasurementValidations ccp.api.molecule.Validation.NmrMeasurementValidation 0..* Validation results that include AbstractMeasurement  
parentList AbstractMeasurementList 1..1 (Parent link). parent link  
peakDims PeakDim 0..* PeakDims used in the derivation of the measurement value. The description in the 'method' may refer to these peakDims.  
peaks Peak 0..* Peaks used in the derivation of the measurement value. The description in the Method may refer to these peaks.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails Text -
setDetails - Text
error
getError Float -
setError - Float
figOfMerit
getFigOfMerit FloatRatio -
setFigOfMerit - FloatRatio
value
getValue Float -
setValue - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dataDerivations
getDataDerivations AbstractDataDerivation Set -
setDataDerivations - AbstractDataDerivation Set
sortedDataDerivations AbstractDataDerivation List -
addDataDerivation - AbstractDataDerivation
removeDataDerivation - AbstractDataDerivation
findFirstDataDerivation AbstractDataDerivation keyword=value pairs
findAllDataDerivations AbstractDataDerivation Set keyword=value pairs
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
nmrMeasurementValidations
getNmrMeasurementValidations ccp.api.molecule.Validation.NmrMeasurementValidation Set -
setNmrMeasurementValidations - ccp.api.molecule.Validation.NmrMeasurementValidation Set
sortedNmrMeasurementValidations ccp.api.molecule.Validation.NmrMeasurementValidation List -
addNmrMeasurementValidation - ccp.api.molecule.Validation.NmrMeasurementValidation
removeNmrMeasurementValidation - ccp.api.molecule.Validation.NmrMeasurementValidation
findFirstNmrMeasurementValidation ccp.api.molecule.Validation.NmrMeasurementValidation keyword=value pairs
findAllNmrMeasurementValidations ccp.api.molecule.Validation.NmrMeasurementValidation Set keyword=value pairs
parentList
getParentList AbstractMeasurementList -
peakDims
getPeakDims PeakDim Set -
setPeakDims - PeakDim Set
sortedPeakDims PeakDim List -
addPeakDim - PeakDim
removePeakDim - PeakDim
findFirstPeakDim PeakDim keyword=value pairs
findAllPeakDims PeakDim Set keyword=value pairs
peaks
getPeaks Peak Set -
setPeaks - Peak Set
sortedPeaks Peak List -
addPeak - Peak
removePeak - Peak
findFirstPeak Peak keyword=value pairs
findAllPeaks Peak Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
None

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_00009

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:33 2014    from data model package  ccp.api.nmr.Nmr.AbstractMeasurement   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk