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

Class: Component


    Component of the decomposition
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link shapeMatrix to class ShapeMatrix
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = Component( shapeMatrix, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
amplitude NonNegativeFloat 1..1 Amplitude of the component.  
annotation Line 0..1 Component annotation. Used to further characterise the nature of the component, e.g. to distinguish between backbone NH and side chain NH2 components for NH based protein experiments.  
regionId NonNegativeInt 0..1 Region ID for Component. Components that share the same regionId are generally calculated together and refer to teh same region of teh spectrum. They can be summed to give a correct representation of the spectrum for the region in question.  
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  
status ComponentStatus 1..1 Status of teh component:  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parent ShapeMatrix 1..1 link to parent object - synonym for shapeMatrix  
shapeMatrix ShapeMatrix 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
amplitude
getAmplitude NonNegativeFloat -
setAmplitude - NonNegativeFloat
annotation
getAnnotation Line -
setAnnotation - Line
regionId
getRegionId NonNegativeInt -
setRegionId - NonNegativeInt
serial
getSerial Int -
setSerial - Int
status
getStatus ComponentStatus -
setStatus - ComponentStatus

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parent
getParent ShapeMatrix -
shapeMatrix
getShapeMatrix ShapeMatrix -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Component 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_2009-06-19-17:41:34_00001

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  Fri Mar 28 11:17:59 2014    from data model package  ccp.api.general.DataLocation.Component   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk