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

Class: HaddockEnergyTerm


    Energy potential term used in Haddock run
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link run to class Run
Main key: code, termId
Mandatory Attributes: code, termId
Known Subclasses: None
Children:
link energyTermParameters to class EnergyTermParameter
Constructor: newObj = HaddockEnergyTerm( run,code=value, termId=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Line 1..1 Code for potential term. Part of class key. Should probably be made into an enumerated data type.  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
fileName PathString 0..1 name of input file (non-CCPN)  
name Line 0..1 User-intelligible name for Energy Term  
termId PositiveInt 1..1 Index of Energy term - distinguishes betweem different terms with the same code. Part of the class key  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
constraintList ccp.api.nmr.NmrConstraint.AbstractConstraintList 0..1 ccp NmrConstraint.ConstraintList associated with HaddockConstraintList  
energyTerm molsim.api.AnnealProtocol.EnergyTerm 0..1 AnnealProtocol EnergyTerm used.  
energyTermParameters EnergyTermParameter 0..* (Child link). child link to class EnergyTermParameter  
parent Run 1..1 link to parent object - synonym for run  
run Run 1..1 (Parent link). parent link  

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
fileName
getFileName PathString -
setFileName - PathString
name
getName Line -
setName - Line
termId
getTermId PositiveInt -
setTermId - PositiveInt

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
constraintList
getConstraintList ccp.api.nmr.NmrConstraint.AbstractConstraintList -
setConstraintList - ccp.api.nmr.NmrConstraint.AbstractConstraintList
energyTerm
getEnergyTerm molsim.api.AnnealProtocol.EnergyTerm -
setEnergyTerm - molsim.api.AnnealProtocol.EnergyTerm
energyTermParameters
getEnergyTermParameters EnergyTermParameter Set -
sortedEnergyTermParameters EnergyTermParameter List -
findFirstEnergyTermParameter EnergyTermParameter keyword=value pairs
findAllEnergyTermParameters EnergyTermParameter Set keyword=value pairs
parent
getParent Run -
run
getRun Run -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey HaddockEnergyTerm 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
newEnergyTermParameter EnergyTermParameter code, value, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-10-11-22:58:43_00006

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:51 2014    from data model package  utrecht.api.Haddock.HaddockEnergyTerm   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk