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

Class: ExpMeasurement


    Property being measured on a dimension of a multidimensional NMR experiment. Most common are shifts, but coupling constants, multi-quantum magnetisation, time (for relaxation time measurements) and others are possible.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrExpPrototype to class NmrExpPrototype
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = ExpMeasurement( nmrExpPrototype, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomSiteWeights Float 0..* Weight of contribution from atomSites to measurement being made, given in same order as the atomSites. Typically +/- 1. Serves to define multiple-quantum magnetisation, distinguishing between e.g. three-spin triple-quantum magnetisation and three-spin single-quantum magnetisation. Has no defined meaning in other cases. If both atomSiteWeights and atomSites are set, their length must be the same.  
measurementType ExpMeasurementType 1..1 Property being measured. Typically chemical shift, but could be e.g. J-coupling or multiple quantum magnetisation.  
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
atomSites AtomSite 0..* AtomSites defining Measurement. For shifts a single one, defining which shift is being measured. For coupling constants a pair defining the sites coupled. For multiple quantum coherences the number apropriate to define the MQ coherence. The order of atomSites in the link is significant, as it corresponds to the order of Measurement.atomSiteWeights (if set).  
expGraphs ExpGraph 0..* Derived. ExpGraphs where ExpMeasurement appears  
expSteps ExpStep 0..* ExpSteps where ExpMeasurement is being accessed. In a completed NmrExpPrototype all ExpMeasurements must be involved in at least one ExpStep.  
nmrExpPrototype NmrExpPrototype 1..1 (Parent link). parent link  
parent NmrExpPrototype 1..1 link to parent object - synonym for nmrExpPrototype  
refExpDimRefs RefExpDimRef 0..* RefExpDimRefs that pertain to the ExpMeasurement.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomSiteWeights
getAtomSiteWeights Float Tuple -
setAtomSiteWeights - Float List
addAtomSiteWeight - Float
removeAtomSiteWeight - Float
measurementType
getMeasurementType ExpMeasurementType -
setMeasurementType - ExpMeasurementType
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomSites
getAtomSites AtomSite Tuple -
setAtomSites - AtomSite List
addAtomSite - AtomSite
removeAtomSite - AtomSite
findFirstAtomSite AtomSite keyword=value pairs
findAllAtomSites AtomSite List keyword=value pairs
expGraphs
getExpGraphs ExpGraph Set - non-std.
sortedExpGraphs ExpGraph List -
findFirstExpGraph ExpGraph keyword=value pairs
findAllExpGraphs ExpGraph Set keyword=value pairs
expSteps
getExpSteps ExpStep Set -
setExpSteps - ExpStep Set
sortedExpSteps ExpStep List -
findFirstExpStep ExpStep keyword=value pairs
findAllExpSteps ExpStep Set keyword=value pairs
nmrExpPrototype
getNmrExpPrototype NmrExpPrototype -
parent
getParent NmrExpPrototype -
refExpDimRefs
getRefExpDimRefs RefExpDimRef Set -
setRefExpDimRefs - RefExpDimRef Set
sortedRefExpDimRefs RefExpDimRef List -
findFirstRefExpDimRef RefExpDimRef keyword=value pairs
findAllRefExpDimRefs RefExpDimRef Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ExpMeasurement 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_2006-08-16-14:22:45_00034

isImplicit:

False

Tag

Value
repositoryId $Id: ExpMeasurement.xml,v 1.51 2011-01-13 14:40:36 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraint name:

lengths_of_atomSites_and_atomSiteWeights_must_conform
Constraint code: len1 = len(self.atomSites)
len2 = len(self.atomSiteWeights)
isValid = (not len1 or not len2 or (len1 == len2))
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:21 2013    from data model package  ccp.api.nmr.NmrExpPrototype.ExpMeasurement   revision 1.51  
  Work done by the CCPN team.
www.ccpn.ac.uk