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

Class: RefOutputSample


    An OutputSampleDef is used to specify that an Experiment created from the parent Protocol should have an OutputSample that accepts Samples belonging to the specified SampleCategory (any if OutputSampleDef.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 = RefOutputSample( protocol, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
amount Float 0..1 The default amount of Sample to create for an OutputSample created from this OutputSampleDef.  
displayUnit Word 0..1 The unit to display for OutputSampleDef.amount.  
name Line 0..1 The name of the OutputSampleDef. 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 OutputSample.name when an OutputSample is created from an OutputSampleDef.  
serial Int 1..1 Unique identifier.  
unit ccp.api.lims.Sample.AmountUnit 0..1 Unit (L, Kg, g/L, s-1, etc.) for OutputSampleDef.amount  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
outputSamples ccp.api.lims.Experiment.OutputSample 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  
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
outputSamples
getOutputSamples ccp.api.lims.Experiment.OutputSample Set -
setOutputSamples - ccp.api.lims.Experiment.OutputSample Set
sortedOutputSamples ccp.api.lims.Experiment.OutputSample List -
addOutputSample - ccp.api.lims.Experiment.OutputSample
removeOutputSample - ccp.api.lims.Experiment.OutputSample
findFirstOutputSample ccp.api.lims.Experiment.OutputSample keyword=value pairs
findAllOutputSamples ccp.api.lims.Experiment.OutputSample Set keyword=value pairs
parent
getParent Protocol -
protocol
getProtocol Protocol -
refSample
getRefSample ccp.api.lims.Sample.RefSample -
setRefSample - ccp.api.lims.Sample.RefSample
step
getStep Step -
setStep - Step

Class Methods (in package)

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

isImplicit:

False

Tag

Value
repositoryId $Id: RefOutputSample.xml,v 1.47 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:40 2013    from data model package  ccp.api.lims.Protocol.RefOutputSample   revision 1.47  
  Work done by the CCPN team.
www.ccpn.ac.uk