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

Class: EnsembleValidation


    Validation result for the total structure ensemble
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link validationStore to class ValidationStore
Main key: serial
Mandatory Attributes: context, keyword
Known Subclasses: None
Children: None
Constructor: newObj = EnsembleValidation( validationStore,context=value, keyword=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
context Word 1..1 The context where tthe keyword and value is defined. Typically the name of a program that both defines the parameter and calculates its value.E.g. 'PROCHECK', 'SHIFTX', ...Used to derive the keywordDefinition  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
figOfMerit FloatRatio 0..1 Figure of merit for validated result - 1.0 is perfect, 0.0 is totally wrong.  
keyword Word 1..1 keyword that defines the validation result  
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): applicationDatabooleanValueclassNamefieldNamesfloatValueinConstructorintValueisDeletedmetaclasspackageNamepackageShortNamequalifiedNametextValue

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
keywordDefinition ccp.api.general.KeywordDefinition.KeywordDefinition 1..1 Derived.   
parent ValidationStore 1..1 link to parent object - synonym for validationStore  
structureEnsemble ccp.api.molecule.MolStructure.StructureEnsemble 0..1 Derived. StructureEnsemble being validated  
validationStore ValidationStore 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
context
getContext Word -
setContext - Word
details
getDetails Text -
setDetails - Text
figOfMerit
getFigOfMerit FloatRatio -
setFigOfMerit - FloatRatio
keyword
getKeyword Word -
setKeyword - Word
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
keywordDefinition
getKeywordDefinition ccp.api.general.KeywordDefinition.KeywordDefinition - non-std.
parent
getParent ValidationStore -
structureEnsemble
getStructureEnsemble ccp.api.molecule.MolStructure.StructureEnsemble - non-std.
validationStore
getValidationStore ValidationStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey EnsembleValidation 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-11-14-17:02:54_00010

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

must_point_to_valid_KeywordDefinition
Constraint code: self.keywordDefinition is not None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:45 2015    from data model package  ccp.api.molecule.Validation.EnsembleValidation   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk