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

Class: EnergyTerm


    Energy term used in a protocol,  with successive scaling factors, refPotentialTerms
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link annealProtocol to class AnnealProtocol
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link potentialScales to class PotentialScale
Constructor: newObj = EnergyTerm( annealProtocol, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Line 0..1 Name identifying EnergyTerm in the context of the application using the protocol  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
name Line 0..1 User-intelligible name of EnergyTerm  
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
annealProtocol AnnealProtocol 1..1 (Parent link). parent link  
haddockEnergyTerms utrecht.api.Haddock.HaddockEnergyTerm 0..* Haddock Run Energy Terms that refer to AnnealProtocol energy term  
nmrCalcEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm 0..* Derived. NmrCalc.EnergyTerms that correspond to EnergyTerm  
parent AnnealProtocol 1..1 link to parent object - synonym for annealProtocol  
potentialScales PotentialScale 0..* (Child link). child link to class PotentialScale  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Line -
setCode - Line
details
getDetails Text -
setDetails - Text
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealProtocol
getAnnealProtocol AnnealProtocol -
haddockEnergyTerms
getHaddockEnergyTerms utrecht.api.Haddock.HaddockEnergyTerm Set -
setHaddockEnergyTerms - utrecht.api.Haddock.HaddockEnergyTerm Set
sortedHaddockEnergyTerms utrecht.api.Haddock.HaddockEnergyTerm List -
addHaddockEnergyTerm - utrecht.api.Haddock.HaddockEnergyTerm
removeHaddockEnergyTerm - utrecht.api.Haddock.HaddockEnergyTerm
findFirstHaddockEnergyTerm utrecht.api.Haddock.HaddockEnergyTerm keyword=value pairs
findAllHaddockEnergyTerms utrecht.api.Haddock.HaddockEnergyTerm Set keyword=value pairs
nmrCalcEnergyTerms
getNmrCalcEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm Set - non-std.
sortedNmrCalcEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm List -
findFirstNmrCalcEnergyTerm ccp.api.nmr.NmrCalc.EnergyTerm keyword=value pairs
findAllNmrCalcEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm Set keyword=value pairs
parent
getParent AnnealProtocol -
potentialScales
getPotentialScales PotentialScale Set -
sortedPotentialScales PotentialScale List -
findFirstPotentialScale PotentialScale keyword=value pairs
findAllPotentialScales PotentialScale Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey EnergyTerm 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
newPotentialScale PotentialScale finalScale, initialScale, annealStage, refPotentialTerm, ...

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_00006

isImplicit:

False

Tag

Value
repositoryId $Id: EnergyTerm.xml,v 1.15 2011-01-13 14:40:37 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:33 2013    from data model package  molsim.api.AnnealProtocol.EnergyTerm   revision 1.15  
  Work done by the CCPN team.
www.ccpn.ac.uk