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

Class: ProtocolInterface


    Interface spercification for protocol
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: name
Mandatory Attributes: name, title
Partitions Children: True
Known Subclasses: None
Children:
link interfaceLabels to class InterfaceLabel
link interfaceParameters to class InterfaceParameter
Constructor: newObj = ProtocolInterface( wmsProtocol,name=value, title=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details Text 0..1 Free text, for notes, explanatory comments, etc.  
info String 0..1 Display information  
name Line 1..1  
title Line 1..1 Display title.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
interfaceLabels InterfaceLabel 0..* (Child link). child link to class InterfaceLabel  
interfaceParameters InterfaceParameter 0..* (Child link). child link to class InterfaceParameter  
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
details
getDetails Text -
setDetails - Text
info
getInfo String -
setInfo - String
name
getName Line -
setName - Line
title
getTitle Line -
setTitle - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
interfaceLabels
getInterfaceLabels InterfaceLabel Set -
sortedInterfaceLabels InterfaceLabel List -
findFirstInterfaceLabel InterfaceLabel keyword=value pairs
findAllInterfaceLabels InterfaceLabel Set keyword=value pairs
interfaceParameters
getInterfaceParameters 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 ProtocolInterface 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
newInterfaceLabel InterfaceLabel label, ...
newInterfaceParameter InterfaceParameter protocolParameter, ...

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_00001

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  Thu Oct 2 16:09:58 2014    from data model package  cambridge.api.WmsProtocol.ProtocolInterface   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk