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

Class: FixedResonance


    Permanent, unchanging copy of Nmr.Resonance.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrConstraintStore to class NmrConstraintStore
Main key: serial
Mandatory Attributes: isotopeCode
Known Subclasses: None
Children:
link chainStateLinks to class ChainStateLink
Constructor: newObj = FixedResonance( nmrConstraintStore,isotopeCode=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details Text 0..1 Free text, for notes, explanatory comments, etc.  
isotopeCode Word 1..1 Isotope code of corresponding isotope. E.g. 1H, 2H, 3He, 13C, ..  
name Line 0..1 Name of Resonance  
resonanceSerial Int 0..1 Serial of corresponding Nmr.Resonance  
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
chainStateLinks ChainStateLink 0..* (Child link). child link to class ChainStateLink  
chemShiftConstraints ChemShiftConstraint 0..* Chemical shift constraints involving FIxedResonance  
covalentlyBound FixedResonance 0..* Resonances on both ends stand for atoms that are covalently linked.  
csaConstraints CsaConstraint 0..* Chemical shift anisotropy constraints involving FIxedResonance  
dihedralConstraints DihedralConstraint 0..* Dihedral angle constraints involving FixedResonance.  
isotope ccp.api.molecule.ChemElement.Isotope 0..1 Derived. Isotope corresponding to FixedResonance  
nmrConstraintStore NmrConstraintStore 1..1 (Parent link). parent link  
pairwiseConstraintItems PairwiseConstraintItem 0..* PairWiseConstraintItems that involve FixedResonance  
parent NmrConstraintStore 1..1 link to parent object - synonym for nmrConstraintStore  
resCoords ResCoord 0..* Coordinate records (ResCoords) from resonance-only structures relevant for FixedResonance  
resonance ccp.api.nmr.Nmr.Resonance 0..1 Derived. Resonance corresponding to FixedResonance, and from which it was created.  
resonanceSet FixedResonanceSet 0..1 FixedResonanceSet (part of assignment for Constraint Lists) involving Resonance.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails Text -
setDetails - Text
isotopeCode
getIsotopeCode Word -
setIsotopeCode - Word
name
getName Line -
setName - Line
resonanceSerial
getResonanceSerial Int -
setResonanceSerial - Int
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
chainStateLinks
getChainStateLinks ChainStateLink Set -
sortedChainStateLinks ChainStateLink List -
findFirstChainStateLink ChainStateLink keyword=value pairs
findAllChainStateLinks ChainStateLink Set keyword=value pairs
chemShiftConstraints
getChemShiftConstraints ChemShiftConstraint Set -
setChemShiftConstraints - ChemShiftConstraint Set
sortedChemShiftConstraints ChemShiftConstraint List -
findFirstChemShiftConstraint ChemShiftConstraint keyword=value pairs
findAllChemShiftConstraints ChemShiftConstraint Set keyword=value pairs
covalentlyBound
getCovalentlyBound FixedResonance Set -
setCovalentlyBound - FixedResonance Set
sortedCovalentlyBound FixedResonance List -
addCovalentlyBound - FixedResonance
removeCovalentlyBound - FixedResonance
findFirstCovalentlyBound FixedResonance keyword=value pairs
findAllCovalentlyBound FixedResonance Set keyword=value pairs
csaConstraints
getCsaConstraints CsaConstraint Set -
setCsaConstraints - CsaConstraint Set
sortedCsaConstraints CsaConstraint List -
findFirstCsaConstraint CsaConstraint keyword=value pairs
findAllCsaConstraints CsaConstraint Set keyword=value pairs
dihedralConstraints
getDihedralConstraints DihedralConstraint Set -
setDihedralConstraints - DihedralConstraint Set
sortedDihedralConstraints DihedralConstraint List -
findFirstDihedralConstraint DihedralConstraint keyword=value pairs
findAllDihedralConstraints DihedralConstraint Set keyword=value pairs
isotope
getIsotope ccp.api.molecule.ChemElement.Isotope - non-std.
nmrConstraintStore
getNmrConstraintStore NmrConstraintStore -
pairwiseConstraintItems
getPairwiseConstraintItems PairwiseConstraintItem Set -
setPairwiseConstraintItems - PairwiseConstraintItem Set
sortedPairwiseConstraintItems PairwiseConstraintItem List -
findFirstPairwiseConstraintItem PairwiseConstraintItem keyword=value pairs
findAllPairwiseConstraintItems PairwiseConstraintItem Set keyword=value pairs
parent
getParent NmrConstraintStore -
resCoords
getResCoords ResCoord Set -
setResCoords - ResCoord Set
sortedResCoords ResCoord List -
findFirstResCoord ResCoord keyword=value pairs
findAllResCoords ResCoord Set keyword=value pairs
resonance
getResonance ccp.api.nmr.Nmr.Resonance - non-std.
resonanceSet
getResonanceSet FixedResonanceSet -
setResonanceSet - FixedResonanceSet

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey FixedResonance 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
newChainStateLink ChainStateLink chainStateSerial, chainStateSetSerial, ...

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:51_00031

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: ccp.api.nmr.NmrConstraint.PairwiseConstraintItem.firstResonanceccp.api.nmr.NmrConstraint.PairwiseConstraintItem.orderedResonances
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:44 2014    from data model package  ccp.api.nmr.NmrConstraint.FixedResonance   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk