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

Class: ProtocolParameter


    WMS parameter, its identification, and type. Contains sufficient information to define a parameter, pass it to (from) the program being run, and set it in NmrCalc.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link wmsProtocol to class WmsProtocol
Main key: serial
Mandatory Attributes: paramType
Known Subclasses: None
Children: None
Constructor: newObj = ProtocolParameter( wmsProtocol,paramType=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 0..1 Unique identifier for the parameter within the context of the application being run  
defaultStrings String 0..* String representation of default values. Will be converted to correct type depending on paramType.  
hicard Int 1..1 Maximum number of exemplars allowed for this parameter. Value -1 is used for 'unlimited'  
ioRole ccp.api.nmr.NmrCalc.IoRole 1..1 Role of data in calculation (input / output).  
locard NonNegativeInt 1..1 Minimum number of exemplars required for this parameter  
name Line 0..1 Name used for NmrCalc identification  
paramType Word 1..1 Parameter type, corresponding to NmrCalc Data or RunParameter types. Necessary only for parameters that are entered in NmrCalc.  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
container ProtocolParameter 0..1 ProtocolParam that contains this Param. Generally used when this parameter relates only to another parameter, e.g. a temperature for an annealing cycle, or a weight for a constraint list.  
content ProtocolParameter 0..* ProtocolParams contained within this parameter. NB, parameters with content can not have values of simple type, as the content is the value.  
interfaceParameters InterfaceParameter 0..* Interface ap0rameters corresponding to parameter  
parent WmsProtocol 1..1 link to parent object - synonym for wmsProtocol  
wmsProtocol WmsProtocol 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Word -
setCode - Word
defaultStrings
getDefaultStrings String Tuple -
setDefaultStrings - String List
addDefaultString - String
removeDefaultString - String
hicard
getHicard Int -
setHicard - Int
ioRole
getIoRole ccp.api.nmr.NmrCalc.IoRole -
setIoRole - ccp.api.nmr.NmrCalc.IoRole
locard
getLocard NonNegativeInt -
setLocard - NonNegativeInt
name
getName Line -
setName - Line
paramType
getParamType Word -
setParamType - Word
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
container
getContainer ProtocolParameter -
setContainer - ProtocolParameter
content
getContent ProtocolParameter Set -
setContent - ProtocolParameter Set
sortedContent ProtocolParameter List -
addContent - ProtocolParameter
removeContent - ProtocolParameter
findFirstContent ProtocolParameter keyword=value pairs
findAllContent ProtocolParameter Set keyword=value pairs
interfaceParameters
getInterfaceParameters InterfaceParameter Set -
setInterfaceParameters - InterfaceParameter Set
sortedInterfaceParameters InterfaceParameter List -
findFirstInterfaceParameter InterfaceParameter keyword=value pairs
findAllInterfaceParameters InterfaceParameter Set keyword=value pairs
parent
getParent WmsProtocol -
wmsProtocol
getWmsProtocol WmsProtocol -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ProtocolParameter 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_2010-05-06-12:26:54_00003

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

Only_simple_parameter_types_can_have_defaults
Constraint code: not self.defaultStrings or self.paramType in ('textValue', 'intValue', 'floatValue', 'booleanValue')

Constraint name:

multiple_defaultStrings_only_for_hicard_ne_1
Constraint code: self.hicard != 1 or len(self.defaultStrings) <= 1
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:58 2014    from data model package  cambridge.api.WmsProtocol.ProtocolParameter   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk