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

Class: SampleComponent


    The information on the sample component. One component is one element of the contents of the sample.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link abstractSample to class AbstractSample
Main key: serial
Mandatory Attributes: refComponent
Known Subclasses: None
Children: None
Constructor: newObj = SampleComponent( abstractSample,refComponent=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
concDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
concentration Float 0..1 Concentration of the component in the sample.  
concentrationError Float 0..1 The concentration error.  
concentrationUnit ConcentrationUnit 0..1 The concentration unit that should be one of these units: kg/m3 for mass density, mol/L (M) for amount-of-substance concentration, m3/m3 for volume fraction, mol/mol for amount of substance fraction and kg/kg for mass fraction.  
details String 0..1 Free text, for notes, explanatory comments, etc.  
purity Float 0..1 The value of the sample component purity.  
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
abstractSample AbstractSample 1..1 (Parent link). parent link  
blueprintComponent ccp.api.lims.ExpBlueprint.BlueprintComponent 0..1  
container SampleComponent 0..1 The container component to which the sub components belong.  
contents SampleComponent 0..* List of sub component contained in another component. This is the contents of a component.  
parent AbstractSample 1..1 link to parent object - synonym for abstractSample  
refComponent ccp.api.lims.RefSampleComponent.AbstractComponent 1..1 The component used as a reference associated to a SampleComponent.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
concDisplayUnit
getConcDisplayUnit Word -
setConcDisplayUnit - Word
concentration
getConcentration Float -
setConcentration - Float
concentrationError
getConcentrationError Float -
setConcentrationError - Float
concentrationUnit
getConcentrationUnit ConcentrationUnit -
setConcentrationUnit - ConcentrationUnit
details
getDetails String -
setDetails - String
purity
getPurity Float -
setPurity - Float
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
abstractSample
getAbstractSample AbstractSample -
blueprintComponent
getBlueprintComponent ccp.api.lims.ExpBlueprint.BlueprintComponent -
setBlueprintComponent - ccp.api.lims.ExpBlueprint.BlueprintComponent
container
getContainer SampleComponent -
setContainer - SampleComponent
contents
getContents SampleComponent Set -
setContents - SampleComponent Set
sortedContents SampleComponent List -
addContent - SampleComponent
removeContent - SampleComponent
findFirstContent SampleComponent keyword=value pairs
findAllContents SampleComponent Set keyword=value pairs
parent
getParent AbstractSample -
refComponent
getRefComponent ccp.api.lims.RefSampleComponent.AbstractComponent -
setRefComponent - ccp.api.lims.RefSampleComponent.AbstractComponent

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey SampleComponent 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:44_00002

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:29 2014    from data model package  ccp.api.lims.Sample.SampleComponent   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk