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

Class: Label


    Label (isotopic, fluorophore, X-ray anomalous scatterer, or other) attached to AbstractComponent. Isotope labeling given in SpecificLabelGroup and IsotopeLabel must be consistent with labeling given in the Label class, as both are valid together.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link component to class AbstractComponent
Main key: serial
Mandatory Attributes: labelName, labelType
Known Subclasses: None
Children: None
Constructor: newObj = Label( component,labelName=value, labelType=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
elementName Word 0..1 Name of element used for labeling. e.g. 'C' for C13 or C14, 'S', for radioactive sulphur, 'Se' for SelenoMethionine. Not set is not applicable.  
incorporation FloatRatio 0..1 Fractional incorporation of label. Not set is not applicable.  
isUniform Boolean 0..1 Is label uniform, i.e. is the label present in all sites where it might be expected? Uniform labeling is for instance where all Methionines were SelenoMethionine, or where all carbons were 13C labeled.  
labelName LabelName 1..1 name of label, describing the exact label used. See datatype for details  
labelType LabelType 1..1 Type of label. See datatype for details  
massNumber Int 0..1 Mass number of isotope of element used for labeling. e.g. 13 for 13C. Not set is not applicable.  
numInstances Int 0..1 number of instances of label present in component. Not set is not applicable.  
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
component AbstractComponent 1..1 (Parent link). parent link  
parent AbstractComponent 1..1 link to parent object - synonym for component  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
elementName
getElementName Word -
setElementName - Word
incorporation
getIncorporation FloatRatio -
setIncorporation - FloatRatio
isUniform
getIsUniform Boolean -
setIsUniform - Boolean
labelName
getLabelName LabelName -
setLabelName - LabelName
labelType
getLabelType LabelType -
setLabelType - LabelType
massNumber
getMassNumber Int -
setMassNumber - Int
numInstances
getNumInstances Int -
setNumInstances - Int
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
component
getComponent AbstractComponent -
parent
getParent AbstractComponent -

Class Methods (in package)

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

isImplicit:

False

Tag

Value
repositoryId $Id: Label.xml,v 1.49 2011-01-13 14:40:33 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:34 2013    from data model package  ccp.api.lims.RefSampleComponent.Label   revision 1.49  
  Work done by the CCPN team.
www.ccpn.ac.uk