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

Class: FlowStep


    Flow step.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link procedure to class Procedure
Main key: serial
Mandatory Attributes: stepNumber
Known Subclasses: None
Children: None
Constructor: newObj = FlowStep( procedure,stepNumber=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
beginProportionSolA Float 0..1 The proportion of solution A at the begining in percent (%).  
details String 0..1 Details field for comments.  
duration Float 0..1 The duration in second (s) of the step.  
durationDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
endProportionSolA Float 0..1 The proportion of solution A at the end in percent (%).  
flowType FlowType 0..1 The type of flow e.g. 'fixed volume', 'one solution flow', '2solutions gradient', ...  
flowrate Float 0..1 The volume of material passing a fixed point per unit of time in L/s.  
flowrateDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
name Line 0..1 The name of the step.  
role Line 0..1 The role of the step that it takes within a procedure or simply its classification number.  
serial Int 1..1 Unique identifier.  
stepNumber Int 1..1 The place of the step in the order of step of the procedure. Need not be sequential, successive steps could be numbered (-10,0,10,12,17,20,...). The steps are performed according to increasing value of this attribute.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parameterDefinitions ParameterDefinition 0..* List of parameter definition associated to a step.  
parent Procedure 1..1 link to parent object - synonym for procedure  
procedure Procedure 1..1 (Parent link). parent link  
refInputSamples RefInputSample 0..* List of InputSampleDefs associated with this Step.  
refOutputSamples RefOutputSample 0..* List of InputSampleDefs associated with this Step.  
solutionA RefInputSample 0..1 solutionA used by the FlowStep.  
solutionB RefInputSample 0..1 solutionB used by the FlowStep.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
beginProportionSolA
getBeginProportionSolA Float -
setBeginProportionSolA - Float
details
getDetails String -
setDetails - String
duration
getDuration Float -
setDuration - Float
durationDisplayUnit
getDurationDisplayUnit Word -
setDurationDisplayUnit - Word
endProportionSolA
getEndProportionSolA Float -
setEndProportionSolA - Float
flowType
getFlowType FlowType -
setFlowType - FlowType
flowrate
getFlowrate Float -
setFlowrate - Float
flowrateDisplayUnit
getFlowrateDisplayUnit Word -
setFlowrateDisplayUnit - Word
name
getName Line -
setName - Line
role
getRole Line -
setRole - Line
serial
getSerial Int -
setSerial - Int
stepNumber
getStepNumber Int -
setStepNumber - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parameterDefinitions
getParameterDefinitions ParameterDefinition Set -
setParameterDefinitions - ParameterDefinition Set
sortedParameterDefinitions ParameterDefinition List -
addParameterDefinition - ParameterDefinition
removeParameterDefinition - ParameterDefinition
findFirstParameterDefinition ParameterDefinition keyword=value pairs
findAllParameterDefinitions ParameterDefinition Set keyword=value pairs
parent
getParent Procedure -
procedure
getProcedure Procedure -
refInputSamples
getRefInputSamples RefInputSample Set -
setRefInputSamples - RefInputSample Set
sortedRefInputSamples RefInputSample List -
addRefInputSample - RefInputSample
removeRefInputSample - RefInputSample
findFirstRefInputSample RefInputSample keyword=value pairs
findAllRefInputSamples RefInputSample Set keyword=value pairs
refOutputSamples
getRefOutputSamples RefOutputSample Set -
setRefOutputSamples - RefOutputSample Set
sortedRefOutputSamples RefOutputSample List -
addRefOutputSample - RefOutputSample
removeRefOutputSample - RefOutputSample
findFirstRefOutputSample RefOutputSample keyword=value pairs
findAllRefOutputSamples RefOutputSample Set keyword=value pairs
solutionA
getSolutionA RefInputSample -
setSolutionA - RefInputSample
solutionB
getSolutionB RefInputSample -
setSolutionB - RefInputSample

Class Methods (in package)

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

isImplicit:

False

Tag

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