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

Class: RefExpDimRef


    ExpDimRef for prototype experiment. Maps ExpDimRef on ExpStep, from which the information necessary for creating ExpDimRef can be found.

    If there is more than one ExpGraph in the NmrExpPrototype, in general each RefExpDim will have an equivalent set of RefExpDimRef for every ExpGraph. Where this is not the case it may be assumed that the 'missing' RefExpDimRefs are 1) identical in content to those present and 2) correspond to the same ExpStep as those given. This convention is used to avoid having several identical RefExpDimRefs just because there are several ExpGraphs.

    Note that the serial attribute is used to match Nmr.ExpDimRefs to RefExpDimRefs, so that objects with the same serial correspond to each other.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link refExpDim to class RefExpDim
Main key: serial
Mandatory Attributes: expMeasurement
Known Subclasses: None
Children: None
Constructor: newObj = RefExpDimRef( refExpDim,expMeasurement=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
constantTime ConstantTimeType 1..1 Is the dimension constant time, variable time, or partial (harmonica type)?  
coupledIsotopeCodes Word 0..* Isotope codes for isotopes, couplings to which are active in the dimension. Note that homonuclear couplings (e.g. proton couplings in a proton dimension) must be specified explicitly if they are to be treated as active. Except for constant-time experiments, homonuclear couplings are normally active, but they may be ignored if they are not resolved and not of interest.  
groupingId Int 1..1 groupingId divides RefExpDimRef from the same parent into groups - all RefExpDimRef with the same groupingId belong in the same group. RefExpDimRef from the same group can appear on the same peak - RefExpDimRef from different groups can not.  
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  
validScalingFactors Float 0..* List of valid scaling factors for RefExpDimRef. If empty, many different factors are allowed. The position of a peak is calculated as the sum over ExpDimRef scaling factors times position values (e.g. position in ppm).  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
coupledIsotopes ccp.api.molecule.ChemElement.Isotope 0..* Derived. Isotopes couplings to which are active in a given dimension.  
expMeasurement ExpMeasurement 1..1 ExpMeasurement to which the RefExpDimRef applies. The reference may be relevant for one or several ExpGraphs.  
expSteps ExpStep 0..* ExpSteps that corresponds to RefExpDimRef. The connection to the ExpMeasurenment is handled via the direct link to ExpMeasurement. The expStep link serves to distinguish which of several ExpSteps compatible with the ExpMeasurement was actually to make a measurement (e.g. was the N15 magnetisation measured before or after the CA magnetisaion in an HNCA experiment.  
parent RefExpDim 1..1 link to parent object - synonym for refExpDim  
refExpDim RefExpDim 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
constantTime
getConstantTime ConstantTimeType -
setConstantTime - ConstantTimeType
coupledIsotopeCodes
getCoupledIsotopeCodes Word Tuple -
setCoupledIsotopeCodes - Word List
addCoupledIsotopeCode - Word
removeCoupledIsotopeCode - Word
groupingId
getGroupingId Int -
setGroupingId - Int
serial
getSerial Int -
setSerial - Int
validScalingFactors
getValidScalingFactors Float Tuple -
setValidScalingFactors - Float List
addValidScalingFactor - Float
removeValidScalingFactor - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
coupledIsotopes
getCoupledIsotopes ccp.api.molecule.ChemElement.Isotope Set - non-std.
sortedCoupledIsotopes ccp.api.molecule.ChemElement.Isotope List -
findFirstCoupledIsotope ccp.api.molecule.ChemElement.Isotope keyword=value pairs
findAllCoupledIsotopes ccp.api.molecule.ChemElement.Isotope Set keyword=value pairs
expMeasurement
getExpMeasurement ExpMeasurement -
setExpMeasurement - ExpMeasurement
expSteps
getExpSteps ExpStep Set -
setExpSteps - ExpStep Set
sortedExpSteps ExpStep List -
addExpStep - ExpStep
removeExpStep - ExpStep
findFirstExpStep ExpStep keyword=value pairs
findAllExpSteps ExpStep Set keyword=value pairs
parent
getParent RefExpDim -
refExpDim
getRefExpDim RefExpDim -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey RefExpDimRef 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_00026

isImplicit:

False

Tag

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

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: ccp.api.nmr.Nmr.ExpDimRef.refExpDimRef
  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.RefExpDimRef   revision 1.55  
  Work done by the CCPN team.
www.ccpn.ac.uk