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

Class: WmsProtocol


    WMS calculation protocol. Includes graphical representation.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class memops.api.Implementation.MemopsRoot
Main key: name
Mandatory Attributes: name
Partitions Children: True
Known Subclasses: None
Children:
link protocolInterfaces to class ProtocolInterface
link protocolParameters to class ProtocolParameter
link protocolServices to class ProtocolService
Constructor: newObj = WmsProtocol( memopsRoot,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annealProtocolCode Line 0..1 AnnealProtocol.code - part of key for derived annealProtocol link  
annealProtocolStoreName Line 0..1 Name of annealProtocolStore - part of key for derived AnnealProtocol link.  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
name Word 1..1 name of protocol (unique key)  
softwareName Line 0..1 Name of Software used - defines derived link to Software. Also part of key for derived annealProtocol link.  
softwareVersion Line 0..1 Version of Software used - defines derived link to Software  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annealProtocol molsim.api.AnnealProtocol.AnnealProtocol 0..1 Derived.   
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
protocolInterfaces ProtocolInterface 0..* (Child link). child link to class ProtocolInterface  
protocolParameters ProtocolParameter 0..* (Child link). child link to class ProtocolParameter  
protocolServices ProtocolService 0..* (Child link). child link to class ProtocolService  
software ccp.api.general.Method.Software 0..1 Derived. Software used for protocol. Found in memopsRoot.currentMethodStore. Elects on matching softwareName and softwareVersion. If no match found returns sofware matching softwareName, if only one is found.  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealProtocolCode
getAnnealProtocolCode Line -
setAnnealProtocolCode - Line
annealProtocolStoreName
getAnnealProtocolStoreName Line -
setAnnealProtocolStoreName - Line
details
getDetails Text -
setDetails - Text
name
getName Word -
setName - Word
softwareName
getSoftwareName Line -
setSoftwareName - Line
softwareVersion
getSoftwareVersion Line -
setSoftwareVersion - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealProtocol
getAnnealProtocol molsim.api.AnnealProtocol.AnnealProtocol - non-std.
setAnnealProtocol - molsim.api.AnnealProtocol.AnnealProtocol non-std.
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
parent
getParent memops.api.Implementation.MemopsRoot -
protocolInterfaces
getProtocolInterfaces ProtocolInterface Set -
sortedProtocolInterfaces ProtocolInterface List -
findFirstProtocolInterface ProtocolInterface keyword=value pairs
findAllProtocolInterfaces ProtocolInterface Set keyword=value pairs
protocolParameters
getProtocolParameters ProtocolParameter Set -
sortedProtocolParameters ProtocolParameter List -
findFirstProtocolParameter ProtocolParameter keyword=value pairs
findAllProtocolParameters ProtocolParameter Set keyword=value pairs
protocolServices
getProtocolServices ProtocolService Set -
sortedProtocolServices ProtocolService List -
findFirstProtocolService ProtocolService keyword=value pairs
findAllProtocolServices ProtocolService Set keyword=value pairs
software
getSoftware ccp.api.general.Method.Software - non-std.
setSoftware - ccp.api.general.Method.Software non-std.

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey WmsProtocol memops.api.Implementation.MemopsRoot, 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
newProtocolInterface ProtocolInterface name, title, ...
newProtocolParameter ProtocolParameter paramType, ...
newProtocolService ProtocolService ...

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_00002

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: cambridge.api.Wms.Task.wmsProtocolmemops.api.Implementation.MemopsRoot.currentWmsProtocol
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:59 2014    from data model package  cambridge.api.WmsProtocol.WmsProtocol   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk