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

Class: InterfaceParameter


    Parameter input interface description
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link protocolInterface to class ProtocolInterface
Main key: serial
Mandatory Attributes: protocolParameter
Known Subclasses: None
Children:
link enumValues to class EnumValue
Constructor: newObj = InterfaceParameter( protocolInterface,protocolParameter=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
col NonNegativeInt 1..1 Column where object is gridded  
colspan NonNegativeInt 1..1 Column span of interface object  
defaultStrings String 0..* String representation of default values. Will be converted to correct type depending on paramType.  
hicard Int 1..1 Max number of instances. -1 is used for no limit. Limit applies to number of instances within each container.  
interfaceGroup Line 0..1 Interface grouping string of interface object. All object with the same interfaceGroup will be displayed together, typically in a separate tab with the same name as the interfaceGroup. If all interfaceGroup values are None, there will be no tabs  
isEditable Boolean 1..1 Is parameter editable (or display-only)?  
isOrdered Boolean 1..1 Are values ordered - relevant only for multiple values.  
locard NonNegativeInt 1..1 Minimum number of instances. Limit applies to number of instances within each container.  
row NonNegativeInt 1..1 Row where object is gridded  
rowspan NonNegativeInt 1..1 Row span of interface object  
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
enumValues EnumValue 0..* (Child link). child link to class EnumValue  
parent ProtocolInterface 1..1 link to parent object - synonym for protocolInterface  
protocolInterface ProtocolInterface 1..1 (Parent link). parent link  
protocolParameter ProtocolParameter 1..1 Protocol paramter defining interface parameter  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
col
getCol NonNegativeInt -
setCol - NonNegativeInt
colspan
getColspan NonNegativeInt -
setColspan - NonNegativeInt
defaultStrings
getDefaultStrings String Tuple -
setDefaultStrings - String List
addDefaultString - String
removeDefaultString - String
hicard
getHicard Int -
setHicard - Int
interfaceGroup
getInterfaceGroup Line -
setInterfaceGroup - Line
isEditable
getIsEditable Boolean -
setIsEditable - Boolean
isOrdered
getIsOrdered Boolean -
setIsOrdered - Boolean
locard
getLocard NonNegativeInt -
setLocard - NonNegativeInt
row
getRow NonNegativeInt -
setRow - NonNegativeInt
rowspan
getRowspan NonNegativeInt -
setRowspan - NonNegativeInt
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
enumValues
getEnumValues EnumValue Set -
sortedEnumValues EnumValue List -
findFirstEnumValue EnumValue keyword=value pairs
findAllEnumValues EnumValue Set keyword=value pairs
parent
getParent ProtocolInterface -
protocolInterface
getProtocolInterface ProtocolInterface -
protocolParameter
getProtocolParameter ProtocolParameter -
setProtocolParameter - ProtocolParameter

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey InterfaceParameter 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
newEnumValue EnumValue ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2011-03-22-17:23:22_00002

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.protocolParameter.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.InterfaceParameter   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk