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

Class: InternalShiftReference


    Chemical Shift referencing. The reference actually used (not the one quoted against). Used for references internal to (part of) the sample.
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: atomGroup, isotopeCode, molName, referenceType, value
Known Subclasses: None
Children: None
Constructor: newObj = InternalShiftReference( nmrProject,atomGroup=value, isotopeCode=value, molName=value, referenceType=value, value=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomGroup Line 1..1 String describing the atom group from the molecule used for referencing.  
indirectShiftRatio Double 0..1 Ratio between nucleus resonance frequency and proton resonance frequency used for indirect shift referencing.  
isotopeCode Word 1..1 Isotope code, e.g. '1H', '3He','13C','235U' etc.  
molName ShiftReferenceMolecule 1..1 Reference compound.  
referenceType ShiftRefType 1..1 Is reference direct or indirect?  
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 shift reference.  
value Float 1..1 Value (frequency) of reference.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
citation ccp.api.general.Citation.Citation 0..1 Citation describing shift reference.  
experiments Experiment 0..* Experiments that use ShiftReference  
isotope ccp.api.molecule.ChemElement.Isotope 1..1 Derived. Isotope being referenced  
nmrProject NmrProject 1..1 (Parent link). parent link  
parent NmrProject 1..1 link to parent object - synonym for nmrProject  
shiftRatioCitation ccp.api.general.Citation.Citation 0..1 Citation for shift ratio used for indirect referencing  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomGroup
getAtomGroup Line -
setAtomGroup - Line
indirectShiftRatio
getIndirectShiftRatio Double -
setIndirectShiftRatio - Double
isotopeCode
getIsotopeCode Word -
setIsotopeCode - Word
molName
getMolName ShiftReferenceMolecule -
setMolName - ShiftReferenceMolecule
referenceType
getReferenceType ShiftRefType -
setReferenceType - ShiftRefType
serial
getSerial Int -
setSerial - Int
unit
getUnit Word -
setUnit - Word
value
getValue Float -
setValue - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
citation
getCitation ccp.api.general.Citation.Citation -
setCitation - ccp.api.general.Citation.Citation
experiments
getExperiments Experiment Set -
setExperiments - Experiment Set
sortedExperiments Experiment List -
addExperiment - Experiment
removeExperiment - Experiment
findFirstExperiment Experiment keyword=value pairs
findAllExperiments Experiment Set keyword=value pairs
isotope
getIsotope ccp.api.molecule.ChemElement.Isotope - non-std.
nmrProject
getNmrProject NmrProject -
parent
getParent NmrProject -
shiftRatioCitation
getShiftRatioCitation ccp.api.general.Citation.Citation -
setShiftRatioCitation - ccp.api.general.Citation.Citation

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey InternalShiftReference 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:47_00007

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