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

Class: ResonanceSet


    Connection between Resonance and AtomSet. Connects to several Resonances and several AtomSets. The semantics are that one object on one side is connected to exactly one object on the other side, with excess objects not belonging, but that it is not known which object maps to which. The typical example is a prochiral group (e.g. a methylene) and the two resonances that corresponds to the two atoms. Linking these into a ResonanceSet reflects the information that each of the resonances corresponds to one (and only one) of the AtomSets, but it is not known which. If there is only one object on each side (and only then), can the Resonance be inferred from the AtomSet and vice versa.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrProject to class NmrProject
Main key: serial
Mandatory Attributes: atomSets, resonances
Known Subclasses: None
Children: None
Constructor: newObj = ResonanceSet( nmrProject,atomSets=value, resonances=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
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
atomSets AtomSet 1..* AtomSets corresponding to ResonanceSet. Part of assignment of Resonances to Atoms.  
nmrProject NmrProject 1..1 (Parent link). parent link  
parent NmrProject 1..1 link to parent object - synonym for nmrProject  
resonances Resonance 1..* Resonances belonging to ResonaceSet. Part of assignment of Atoms to Resonances.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomSets
getAtomSets AtomSet Set -
setAtomSets - AtomSet Set
sortedAtomSets AtomSet List -
addAtomSet - AtomSet
removeAtomSet - AtomSet
findFirstAtomSet AtomSet keyword=value pairs
findAllAtomSets AtomSet Set keyword=value pairs
nmrProject
getNmrProject NmrProject -
parent
getParent NmrProject -
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 ResonanceSet 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:47_00038

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: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:32 2014    from data model package  ccp.api.nmr.Nmr.ResonanceSet   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk