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

Class: ChainState


    One state of a molecule, belonging to a specific ChainStateSite. E.g. 'cis', 'protonated', 'bound-form', or 'loop-conformation-A'
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link chainStateSet to class ChainStateSet
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = ChainState( chainStateSet, ... )

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 ChainState. Used to characterise the state (e.g. 'cis' and 'trans' would be a good name for the states of a cis/trans ChainStateSet). See documentation to ChainStateSet for detailed recommendations.  
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
chainStateSet ChainStateSet 1..1 (Parent link). parent link  
expChainStates ExpChainState 0..* ExpChainStates in which ChainState is involved.  
nmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore 0..* NmrConstraintStores using for this particular ChainState  
parent ChainStateSet 1..1 link to parent object - synonym for chainStateSet  
resonances Resonance 0..* Resonances that are found only in this chainState.  

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
chainStateSet
getChainStateSet ChainStateSet -
expChainStates
getExpChainStates ExpChainState Set -
setExpChainStates - ExpChainState Set
sortedExpChainStates ExpChainState List -
findFirstExpChainState ExpChainState keyword=value pairs
findAllExpChainStates ExpChainState Set keyword=value pairs
nmrConstraintStores
getNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore Set -
setNmrConstraintStores - ccp.api.nmr.NmrConstraint.NmrConstraintStore Set
sortedNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore List -
addNmrConstraintStore - ccp.api.nmr.NmrConstraint.NmrConstraintStore
removeNmrConstraintStore - ccp.api.nmr.NmrConstraint.NmrConstraintStore
findFirstNmrConstraintStore ccp.api.nmr.NmrConstraint.NmrConstraintStore keyword=value pairs
findAllNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore Set keyword=value pairs
parent
getParent ChainStateSet -
resonances
getResonances Resonance Set -
setResonances - Resonance Set
sortedResonances Resonance List -
addResonance - Resonance
removeResonance - Resonance
findFirstResonance Resonance keyword=value pairs
findAllResonances Resonance Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ChainState 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_2006-08-16-14:22:46_00017

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.ChainStateLink.chainState
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:53 2015    from data model package  ccp.api.nmr.Nmr.ChainState   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk