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

Class: RefInputSample


    An InputSampleDef is used to specify that an Experiment created from the parent Protocol should have an InputSample that accepts Samples belonging to the specified SampleCategory (any if InputSampleDef.sampleCategory is null).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link protocol to class Protocol
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = RefInputSample( protocol, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
amount Float 0..1 The default amount of Sample to use for an InputSample created from this InputSampleDef.  
displayUnit Word 0..1 The unit to display for InputSampleDef.amount.  
name Line 0..1 The name of the InputSampleDef. It is envisioned that this will be something useful to the user during the viewing and editing of Protocols. This should also be copied down to InputSample.name when an InputSample is created from an InputSampleDef.  
serial Int 1..1 Unique identifier.  
unit ccp.api.lims.Sample.AmountUnit 0..1 Unit (L, Kg, g/L, s-1, etc.) for InputSampleDef.amount  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
addSteps AddStep 0..* Steps where the Materiel is involved.  
inputSamples ccp.api.lims.Experiment.InputSample 0..*  
parent Protocol 1..1 link to parent object - synonym for protocol  
protocol Protocol 1..1 (Parent link). parent link  
refSample ccp.api.lims.Sample.RefSample 0..1  
solAflowSteps FlowStep 0..* FlowSteps where the solutionA is involved.  
solBflowSteps FlowStep 0..* FlowSteps where the solutionB is involved.  
step Step 0..1 The Step the InputSampleDef belongs to.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
amount
getAmount Float -
setAmount - Float
displayUnit
getDisplayUnit Word -
setDisplayUnit - Word
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
unit
getUnit ccp.api.lims.Sample.AmountUnit -
setUnit - ccp.api.lims.Sample.AmountUnit

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
addSteps
getAddSteps AddStep Set -
setAddSteps - AddStep Set
sortedAddSteps AddStep List -
findFirstAddStep AddStep keyword=value pairs
findAllAddSteps AddStep Set keyword=value pairs
inputSamples
getInputSamples ccp.api.lims.Experiment.InputSample Set -
setInputSamples - ccp.api.lims.Experiment.InputSample Set
sortedInputSamples ccp.api.lims.Experiment.InputSample List -
addInputSample - ccp.api.lims.Experiment.InputSample
removeInputSample - ccp.api.lims.Experiment.InputSample
findFirstInputSample ccp.api.lims.Experiment.InputSample keyword=value pairs
findAllInputSamples ccp.api.lims.Experiment.InputSample Set keyword=value pairs
parent
getParent Protocol -
protocol
getProtocol Protocol -
refSample
getRefSample ccp.api.lims.Sample.RefSample -
setRefSample - ccp.api.lims.Sample.RefSample
solAflowSteps
getSolAflowSteps FlowStep Set -
setSolAflowSteps - FlowStep Set
sortedSolAflowSteps FlowStep List -
addSolAflowStep - FlowStep
removeSolAflowStep - FlowStep
findFirstSolAflowStep FlowStep keyword=value pairs
findAllSolAflowSteps FlowStep Set keyword=value pairs
solBflowSteps
getSolBflowSteps FlowStep Set -
setSolBflowSteps - FlowStep Set
sortedSolBflowSteps FlowStep List -
addSolBflowStep - FlowStep
removeSolBflowStep - FlowStep
findFirstSolBflowStep FlowStep keyword=value pairs
findAllSolBflowSteps FlowStep Set keyword=value pairs
step
getStep Step -
setStep - Step

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey RefInputSample 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:45_00016

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