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

Class: PotentialScale


    Restraint potential scaling
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link energyTerm to class EnergyTerm
Main key: annealStage, code
Mandatory Attributes: finalScale, initialScale, annealStage, refPotentialTerm
Known Subclasses: None
Children: None
Constructor: newObj = PotentialScale( energyTerm,finalScale=value, initialScale=value, annealStage=value, refPotentialTerm=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Line 1..1 Code identifying teh relevant potential scale in the context of the application using the protocol. INtended for potential terms that have more than one defining parameter being contnuopusly varied, like Haddock RDC angle projections restraints. For terms that have only one scaling constant (the normal case) this should be left to its default value 'std'.  
finalScale NonNegativeFloat 1..1 Scale at the end of the stage.  
function ScaleFunction 1..1 Function used for scaling. See ScaleFunction data type for details  
functionParams Float 0..* Parameters for the scaling function. Their number and meaning depends on the value of 'function'.  
initialScale NonNegativeFloat 1..1 Scale at the start of the stage  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annealStage AnnealStage 1..1 AnnealStage to which Potential scale refers  
energyTerm EnergyTerm 1..1 (Parent link). parent link  
parent EnergyTerm 1..1 link to parent object - synonym for energyTerm  
refPotentialTerm RefPotentialTerm 1..1 Potential term applied  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Line -
setCode - Line
finalScale
getFinalScale NonNegativeFloat -
setFinalScale - NonNegativeFloat
function
getFunction ScaleFunction -
setFunction - ScaleFunction
functionParams
getFunctionParams Float Tuple -
setFunctionParams - Float List
addFunctionParam - Float
removeFunctionParam - Float
initialScale
getInitialScale NonNegativeFloat -
setInitialScale - NonNegativeFloat

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealStage
getAnnealStage AnnealStage -
setAnnealStage - AnnealStage
energyTerm
getEnergyTerm EnergyTerm -
parent
getParent EnergyTerm -
refPotentialTerm
getRefPotentialTerm RefPotentialTerm -
setRefPotentialTerm - RefPotentialTerm

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey PotentialScale 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
None

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_00007

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  Fri Mar 28 11:18:14 2014    from data model package  molsim.api.AnnealProtocol.PotentialScale   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk