Data Model version 2.1.2
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 crystallizationStore to class CrystallizationStore
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = ParameterDefinition( crystallizationStore, ... )

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.  
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 ccp.api.general.Method.ParamType 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
crystallizationStore CrystallizationStore 1..1 (Parent link). parent link  
parameters Parameter 0..*  
parent CrystallizationStore 1..1 link to parent object - synonym for crystallizationStore  

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
maxValue
getMaxValue Line -
setMaxValue - Line
minValue
getMinValue Line -
setMinValue - Line
name
getName Line -
setName - Line
paramType
getParamType ccp.api.general.Method.ParamType -
setParamType - ccp.api.general.Method.ParamType
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
crystallizationStore
getCrystallizationStore CrystallizationStore -
parameters
getParameters Parameter Set -
setParameters - Parameter Set
sortedParameters Parameter List -
findFirstParameter Parameter keyword=value pairs
findAllParameters Parameter Set keyword=value pairs
parent
getParent CrystallizationStore -

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:54_00061

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