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

Class: Residue

The Residue destructor includes non-standard actions.
    Residue in Molsystem Coordinate description
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link chain to class Chain
Main key: seqId
Mandatory Attributes: seqCode, seqId
Known Subclasses: None
Children:
link atoms to class Atom
Constructor: newObj = Residue( chain,seqCode=value, seqId=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
seqCode Int 1..1 Molecular sequence number as used in Coordinate description.  
seqId Int 1..1 Identifier corresponding to the molResidue identifier (self.residue.molResidue.serial)  
seqInsertCode Line 1..1 Molecular sequence insert code as used in Coordinate description.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atoms Atom 0..* (Child link). child link to class Atom  
chain Chain 1..1 (Parent link). parent link  
parent Chain 1..1 link to parent object - synonym for chain  
residue ccp.api.molecule.MolSystem.Residue 0..1 Derived. MolSystem Residue, coresponding to Coordinate Residue  
residueValidations ccp.api.molecule.Validation.ResidueValidation 0..* Validation results that include Residue  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
seqCode
getSeqCode Int -
setSeqCode - Int
seqId
getSeqId Int -
setSeqId - Int
seqInsertCode
getSeqInsertCode Line -
setSeqInsertCode - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atoms
getAtoms Atom Set -
sortedAtoms Atom List -
findFirstAtom Atom keyword=value pairs
findAllAtoms Atom Set keyword=value pairs
chain
getChain Chain -
parent
getParent Chain -
residue
getResidue ccp.api.molecule.MolSystem.Residue - non-std.
residueValidations
getResidueValidations ccp.api.molecule.Validation.ResidueValidation Set -
setResidueValidations - ccp.api.molecule.Validation.ResidueValidation Set
sortedResidueValidations ccp.api.molecule.Validation.ResidueValidation List -
addResidueValidation - ccp.api.molecule.Validation.ResidueValidation
removeResidueValidation - ccp.api.molecule.Validation.ResidueValidation
findFirstResidueValidation ccp.api.molecule.Validation.ResidueValidation keyword=value pairs
findAllResidueValidations ccp.api.molecule.Validation.ResidueValidation Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Residue 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
newAtom Atom name, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:55_00003

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

# Check if there are models
if not self.root.override:
  # The following code interacts directly with the deletion implementation (use of 'objsToBeDeleted').
  # This is bad, but the only way to accomplish the desired result.
  if self.chain not in objsToBeDeleted:
    if self.topObject.findFirstModel() is not None:
      raise ApiError("Residues may not be deleted in StructureEnsembles with Models")

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:30 2014    from data model package  ccp.api.molecule.MolStructure.Residue   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk