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

Class: InputSample


    This is used to imply several input samples in one experiment and also one input sample in several experiments.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link experiment to class Experiment
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = InputSample( experiment, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
amount Float 0..1 The amount of the sample used by the experiment.  
amountDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
amountUnit ccp.api.lims.Sample.AmountUnit 0..1 One of the three possible units: kg, m3 or number.  
name Line 0..1 The name to display for this InputSample.  
role Line 0..1 The role of the sample that it takes during the experiment or simply its classification number.  
serial Int 1..1 Unique identifier.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
experiment Experiment 1..1 (Parent link). parent link  
parent Experiment 1..1 link to parent object - synonym for experiment  
refInputSample ccp.api.lims.Protocol.RefInputSample 0..1  
sample ccp.api.lims.Sample.Sample 0..1 Sample involved as an input sample of an experiment.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
amount
getAmount Float -
setAmount - Float
amountDisplayUnit
getAmountDisplayUnit Word -
setAmountDisplayUnit - Word
amountUnit
getAmountUnit ccp.api.lims.Sample.AmountUnit -
setAmountUnit - ccp.api.lims.Sample.AmountUnit
name
getName Line -
setName - Line
role
getRole Line -
setRole - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
experiment
getExperiment Experiment -
parent
getParent Experiment -
refInputSample
getRefInputSample ccp.api.lims.Protocol.RefInputSample -
setRefInputSample - ccp.api.lims.Protocol.RefInputSample
sample
getSample ccp.api.lims.Sample.Sample -
setSample - ccp.api.lims.Sample.Sample

Class Methods (in package)

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

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