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

Class: AnnealProtocol


    Annealing protocol - describes an annealing / dynamics simulation in general terms.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link annealProtocolStore to class AnnealProtocolStore
Main key: application, code
Mandatory Attributes: application, code, name
Known Subclasses: None
Children:
link annealStages to class AnnealStage
link energyTerms to class EnergyTerm
Constructor: newObj = AnnealProtocol( annealProtocolStore,application=value, code=value, name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
application Line 1..1 Name of application that uses the protocol. Part of Object key. Part of key for derived link 'software'  
applicationVersion Line 0..1 Version of application used. part of key for derived link software  
code Line 1..1 Application-specific name for the protocol. Part of class key.  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
methodStoreName Line 0..1 Name of MethodStore used to store Software. Part of key for derived link software  
name Line 1..1 name of AnnealProtocol. in human-readable form  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annealProtocolStore AnnealProtocolStore 1..1 (Parent link). parent link  
annealStages AnnealStage 0..* (Child link). child link to class AnnealStage  
energyTerms EnergyTerm 0..* (Child link). child link to class EnergyTerm  
haddockRuns utrecht.api.Haddock.Run 0..* Haddock runs using annealing protocol  
nmrCalcRuns ccp.api.nmr.NmrCalc.Run 0..* Derived. NmrCalc.Runs carried out with AnnealProtocol  
parent AnnealProtocolStore 1..1 link to parent object - synonym for annealProtocolStore  
software ccp.api.general.Method.Software 0..1 Derived. Software used in annealing protocol  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
application
getApplication Line -
setApplication - Line
applicationVersion
getApplicationVersion Line -
setApplicationVersion - Line
code
getCode Line -
setCode - Line
details
getDetails Text -
setDetails - Text
methodStoreName
getMethodStoreName Line -
setMethodStoreName - Line
name
getName Line -
setName - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealProtocolStore
getAnnealProtocolStore AnnealProtocolStore -
annealStages
getAnnealStages AnnealStage Set -
sortedAnnealStages AnnealStage List -
findFirstAnnealStage AnnealStage keyword=value pairs
findAllAnnealStages AnnealStage Set keyword=value pairs
energyTerms
getEnergyTerms EnergyTerm Set -
sortedEnergyTerms EnergyTerm List -
findFirstEnergyTerm EnergyTerm keyword=value pairs
findAllEnergyTerms EnergyTerm Set keyword=value pairs
haddockRuns
getHaddockRuns utrecht.api.Haddock.Run Set -
setHaddockRuns - utrecht.api.Haddock.Run Set
sortedHaddockRuns utrecht.api.Haddock.Run List -
addHaddockRun - utrecht.api.Haddock.Run
removeHaddockRun - utrecht.api.Haddock.Run
findFirstHaddockRun utrecht.api.Haddock.Run keyword=value pairs
findAllHaddockRuns utrecht.api.Haddock.Run Set keyword=value pairs
nmrCalcRuns
getNmrCalcRuns ccp.api.nmr.NmrCalc.Run Set - non-std.
sortedNmrCalcRuns ccp.api.nmr.NmrCalc.Run List -
findFirstNmrCalcRun ccp.api.nmr.NmrCalc.Run keyword=value pairs
findAllNmrCalcRuns ccp.api.nmr.NmrCalc.Run Set keyword=value pairs
parent
getParent AnnealProtocolStore -
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 AnnealProtocol 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
newAnnealStage AnnealStage numSteps, ...
newEnergyTerm EnergyTerm ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2007-06-05-13:42:05_00004

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.WmsProtocol.WmsProtocol.annealProtocol
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:25 2014    from data model package  molsim.api.AnnealProtocol.AnnealProtocol   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk