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

Class: IsotopeLabel


    Isotope label or labeling pattern. Refers to elements of a type given by elementSymbol. If self.molResidues is set the substitution is limited to these residues. If self.atomNames is set the substitution is limited to atoms with these names.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link specificLabelGroup to class SpecificLabelGroup
Main key: serial
Mandatory Attributes: elementSymbol, massNumber
Known Subclasses: None
Children: None
Constructor: newObj = IsotopeLabel( specificLabelGroup,elementSymbol=value, massNumber=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomNames Word 0..* Names of atoms that have been isotope substituted. Applies to the residues given by self.molResidues, or, if self.molResidues is empty, to the entire molecule.  
elementSymbol Word 1..1 Element symbol for chemical element that is isotope substituted.  
incorporation FloatRatio 0..1 Fraction of element that is consists of isotope. Unless given specifically in another IsotopeLabel, the rest of the element is assumed to consist of the isotopes in their natural abundance.  
massNumber Int 1..1 Mass number of incorporated isotope .  
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
molResidues ccp.api.molecule.Molecule.MolResidue 0..* MolResidues to which isotope labeling applies. If not set, the isotope labeling applies to all residues in Molecule.  
parent SpecificLabelGroup 1..1 link to parent object - synonym for specificLabelGroup  
specificLabelGroup SpecificLabelGroup 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomNames
getAtomNames Word Tuple -
setAtomNames - Word List
addAtomName - Word
removeAtomName - Word
elementSymbol
getElementSymbol Word -
setElementSymbol - Word
incorporation
getIncorporation FloatRatio -
setIncorporation - FloatRatio
massNumber
getMassNumber Int -
setMassNumber - Int
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
molResidues
getMolResidues ccp.api.molecule.Molecule.MolResidue Set -
setMolResidues - ccp.api.molecule.Molecule.MolResidue Set
sortedMolResidues ccp.api.molecule.Molecule.MolResidue List -
addMolResidue - ccp.api.molecule.Molecule.MolResidue
removeMolResidue - ccp.api.molecule.Molecule.MolResidue
findFirstMolResidue ccp.api.molecule.Molecule.MolResidue keyword=value pairs
findAllMolResidues ccp.api.molecule.Molecule.MolResidue Set keyword=value pairs
parent
getParent SpecificLabelGroup -
specificLabelGroup
getSpecificLabelGroup SpecificLabelGroup -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey IsotopeLabel 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:53_00011

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  Mon Mar 2 17:24:44 2015    from data model package  ccp.api.lims.RefSampleComponent.IsotopeLabel   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk