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

Class: MolResidueData


    MolSystem.Residue data for calculations
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: serial
Mandatory Attributes: chainCode, molSystemCode
Known Subclasses: None
Children: None
Constructor: newObj = MolResidueData( run,chainCode=value, molSystemCode=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
chainCode Line 1..1 Chain code of relevant Chain - used in deriving link to Residues  
code Word 0..1 Unique identifier for the parameter within the context of the application being run  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
groupId Int 0..1 Integer, grouping related parameters within the context of the application being run  
ioRole IoRole 1..1 Role of data in calculation (input / output).  
molSystemCode Word 1..1 Molsystem code of relevant MolSystem - used in deriving link to Residues  
name Line 0..1 Human readable name of parameter  
residueSeqIds Int 0..* Residue seqIds of residues linked to - if empty all residues in chain are used.  
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  
weight FloatRatio 1..1 Weight given to data  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
chain ccp.api.molecule.MolSystem.Chain 0..1 Derived. MolSystem.Chain containing residue data  
molSystem ccp.api.molecule.MolSystem.MolSystem 0..1 Derived. MolSystem for residue data  
parent Run 1..1 link to parent object - synonym for run  
residues ccp.api.molecule.MolSystem.Residue 0..* Derived. MolSystem.Residues used for data  
run Run 1..1 (Parent link). parent link  
runParameters RunParameter 0..* parameters that refer to unit of data.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
chainCode
getChainCode Line -
setChainCode - Line
code
getCode Word -
setCode - Word
details
getDetails Text -
setDetails - Text
groupId
getGroupId Int -
setGroupId - Int
ioRole
getIoRole IoRole -
setIoRole - IoRole
molSystemCode
getMolSystemCode Word -
setMolSystemCode - Word
name
getName Line -
setName - Line
residueSeqIds
getResidueSeqIds Int Tuple -
setResidueSeqIds - Int List
addResidueSeqId - Int
removeResidueSeqId - Int
serial
getSerial Int -
setSerial - Int
weight
getWeight FloatRatio -
setWeight - FloatRatio

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
chain
getChain ccp.api.molecule.MolSystem.Chain - non-std.
setChain - ccp.api.molecule.MolSystem.Chain non-std.
molSystem
getMolSystem ccp.api.molecule.MolSystem.MolSystem - non-std.
parent
getParent Run -
residues
getResidues ccp.api.molecule.MolSystem.Residue Set - non-std.
setResidues - ccp.api.molecule.MolSystem.Residue Set non-std.
sortedResidues ccp.api.molecule.MolSystem.Residue List -
addResidue - ccp.api.molecule.MolSystem.Residue
removeResidue - ccp.api.molecule.MolSystem.Residue
findFirstResidue ccp.api.molecule.MolSystem.Residue keyword=value pairs
findAllResidues ccp.api.molecule.MolSystem.Residue Set keyword=value pairs
run
getRun Run -
runParameters
getRunParameters RunParameter Set -
setRunParameters - RunParameter Set
sortedRunParameters RunParameter List -
addRunParameter - RunParameter
removeRunParameter - RunParameter
findFirstRunParameter RunParameter keyword=value pairs
findAllRunParameters RunParameter Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey MolResidueData 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_2009-05-20-16:32:11_00003

isImplicit:

False

Tag

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