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

Class: ParameterDefinition


    The list of possible parameters associated with a protocol where the values are associated with an Experiment.
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 = ParameterDefinition( protocol, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
defaultValue Line 0..1 The default value of the parameter.  
displayUnit Word 0..1 Display unit of the parameter.  
label String 0..1 Label of the parameter.  
mandatory Boolean 0..1 Flag to indicate whether it is mandatory for a value to be assigned to any Parameters derived from this ParameterDefinition before the Parameter's parent Experiment can be considered completed.  
maxValue Line 0..1 The maximum value of the parameter.  
minValue Line 0..1 The minimum value of the parameter.  
name Line 0..1 The name of the parameter.  
paramType ParamDefType 0..1 parameter type of parameter (as in Float, String, ...)  
possibleValues Line 0..* The list of possible values for the parameter.  
serial Int 1..1 Unique identifier.  
unit Word 0..1 Unit of parameter (L, Kg, g/L, s-1, etc.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parameters ccp.api.lims.Experiment.Parameter 0..*  
parent Protocol 1..1 link to parent object - synonym for protocol  
protocol Protocol 1..1 (Parent link). parent link  
step Step 0..1 The step where the parameter definition should be defined.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
defaultValue
getDefaultValue Line -
setDefaultValue - Line
displayUnit
getDisplayUnit Word -
setDisplayUnit - Word
label
getLabel String -
setLabel - String
mandatory
getMandatory Boolean -
setMandatory - Boolean
maxValue
getMaxValue Line -
setMaxValue - Line
minValue
getMinValue Line -
setMinValue - Line
name
getName Line -
setName - Line
paramType
getParamType ParamDefType -
setParamType - ParamDefType
possibleValues
getPossibleValues Line Tuple -
setPossibleValues - Line List
addPossibleValue - Line
removePossibleValue - Line
serial
getSerial Int -
setSerial - Int
unit
getUnit Word -
setUnit - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parameters
getParameters ccp.api.lims.Experiment.Parameter Set -
setParameters - ccp.api.lims.Experiment.Parameter Set
sortedParameters ccp.api.lims.Experiment.Parameter List -
addParameter - ccp.api.lims.Experiment.Parameter
removeParameter - ccp.api.lims.Experiment.Parameter
findFirstParameter ccp.api.lims.Experiment.Parameter keyword=value pairs
findAllParameters ccp.api.lims.Experiment.Parameter Set keyword=value pairs
parent
getParent Protocol -
protocol
getProtocol Protocol -
step
getStep Step -
setStep - Step

Class Methods (in package)

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

isImplicit:

False

Tag

Value
repositoryId $Id: ParameterDefinition.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.ParameterDefinition   revision 1.47  
  Work done by the CCPN team.
www.ccpn.ac.uk