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

Class: ResLabel


    Residue labeling pattern. If there are any SingleAtomLabels for a given atom, these uniquely determine the isotope composition. Failing that, if there are any UniformLabels for a given atom, these uniquely determine the isotope composition. Failing that the composition is determined  by the ResLabelFractions.
    Note that AtomLabels effectively specify the isotope composition one position at a time. Any correlations between the labeling patterns of two (or more) Atoms can only be specified with the ResLabelFractions.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link molLabel to class MolLabel
Main key: resId
Mandatory Attributes: resId
Known Subclasses: None
Children:
link atomLabels to class AtomLabel
link resLabelFractions to class ResLabelFraction
Constructor: newObj = ResLabel( molLabel,resId=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
resId PositiveInt 1..1 resId for corresponding MolResidue  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomLabels AtomLabel 0..* (Child link). child link to class AtomLabel  
molLabel MolLabel 1..1 (Parent link). parent link  
molResidue ccp.api.molecule.Molecule.MolResidue 0..1 Derived. molResidues whose labeling is described  
parent MolLabel 1..1 link to parent object - synonym for molLabel  
resLabelFractions ResLabelFraction 0..* (Child link). child link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
resId
getResId PositiveInt -
setResId - PositiveInt

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomLabels
getAtomLabels AtomLabel Set -
sortedAtomLabels AtomLabel List -
findFirstAtomLabel AtomLabel keyword=value pairs
findAllAtomLabels AtomLabel Set keyword=value pairs
molLabel
getMolLabel MolLabel -
molResidue
getMolResidue ccp.api.molecule.Molecule.MolResidue - non-std.
parent
getParent MolLabel -
resLabelFractions
getResLabelFractions ResLabelFraction Set -
sortedResLabelFractions ResLabelFraction List -
findFirstResLabelFraction ResLabelFraction keyword=value pairs
findAllResLabelFractions ResLabelFraction Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ResLabel 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
newResLabelFraction ResLabelFraction ...
newSingleAtomLabel SingleAtomLabel atomName, massNumber, ...
newUniformAtomLabel UniformAtomLabel elementName, massNumber, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-10-24-11:28:55_00004

isImplicit:

False

Tag

Value
repositoryId $Id: ResLabel.xml,v 1.46 2011-01-13 14:40:34 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: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:31 2013    from data model package  ccp.api.molecule.LabeledMolecule.ResLabel   revision 1.46  
  Work done by the CCPN team.
www.ccpn.ac.uk