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

Class: Model


    A single structure instance that is part of the structure ensemble. Corresponds to a PDB MODEL.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link structureEnsemble to class StructureEnsemble
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = Model( structureEnsemble, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details Text 0..1 Free text, for notes, explanatory comments, etc.  
name Line 0..1 Name of model  
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
coords Coord 0..* Coordinates in model  
parent StructureEnsemble 1..1 link to parent object - synonym for structureEnsemble  
structureEnsemble StructureEnsemble 1..1 (Parent link). parent link  
structureGroups ccp.api.molecule.MolSystem.StructureGroup 0..* StructureGroups that Model belongs to.  
structureValidations ccp.api.molecule.Validation.StructureValidation 0..* Validation results for Model  
violationLists ccp.api.nmr.NmrConstraint.ViolationList 0..* NmrConstraint.ViolationLists calculated using Model  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
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
coords
getCoords Coord Set -
setCoords - Coord Set
sortedCoords Coord List -
findFirstCoord Coord keyword=value pairs
findAllCoords Coord Set keyword=value pairs
parent
getParent StructureEnsemble -
structureEnsemble
getStructureEnsemble StructureEnsemble -
structureGroups
getStructureGroups ccp.api.molecule.MolSystem.StructureGroup Set -
setStructureGroups - ccp.api.molecule.MolSystem.StructureGroup Set
sortedStructureGroups ccp.api.molecule.MolSystem.StructureGroup List -
addStructureGroup - ccp.api.molecule.MolSystem.StructureGroup
removeStructureGroup - ccp.api.molecule.MolSystem.StructureGroup
findFirstStructureGroup ccp.api.molecule.MolSystem.StructureGroup keyword=value pairs
findAllStructureGroups ccp.api.molecule.MolSystem.StructureGroup Set keyword=value pairs
structureValidations
getStructureValidations ccp.api.molecule.Validation.StructureValidation Set -
setStructureValidations - ccp.api.molecule.Validation.StructureValidation Set
sortedStructureValidations ccp.api.molecule.Validation.StructureValidation List -
addStructureValidation - ccp.api.molecule.Validation.StructureValidation
removeStructureValidation - ccp.api.molecule.Validation.StructureValidation
findFirstStructureValidation ccp.api.molecule.Validation.StructureValidation keyword=value pairs
findAllStructureValidations ccp.api.molecule.Validation.StructureValidation Set keyword=value pairs
violationLists
getViolationLists ccp.api.nmr.NmrConstraint.ViolationList Set -
setViolationLists - ccp.api.nmr.NmrConstraint.ViolationList Set
sortedViolationLists ccp.api.nmr.NmrConstraint.ViolationList List -
addViolationList - ccp.api.nmr.NmrConstraint.ViolationList
removeViolationList - ccp.api.nmr.NmrConstraint.ViolationList
findFirstViolationList ccp.api.nmr.NmrConstraint.ViolationList keyword=value pairs
findAllViolationLists ccp.api.nmr.NmrConstraint.ViolationList Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Model 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-23-12:00:10_00001

isImplicit:

False

Tag

Value
repositoryId $Id: Model.xml,v 1.20 2011-01-13 14:40:34 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: ccp.api.nmr.NmrCalc.StructureEnsembleData.models
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:38 2013    from data model package  ccp.api.molecule.MolStructure.Model   revision 1.20  
  Work done by the CCPN team.
www.ccpn.ac.uk