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

Class: ResonanceGroupProb


    Link class for ResonanceGroup-to-ResonanceGroup link. Holds information about the kind of link and its probability. To calculate probabilities, weights are summed over all ResonanceGroupProbs belonging to the same resonance with the same linktype and the same sequenceOffset. sequenceOffset and the linktype are cooperative, so that e.g. linkType == 'basepaired', sequenceOffset == -1 means the base that is basepaired to the preceding base of the sequence. For non-polymers sequenceOffsets are strictly speaking meaningless, but as a special convention the sequenceOffset '1' is interpreted as 'directly bonded to current ResonanceGroup'.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link fromResonanceGroup to class ResonanceGroup
Main key: linkType, possibility
Mandatory Attributes: linkType, possibility
Known Subclasses: None
Children: None
Constructor: newObj = ResonanceGroupProb( fromResonanceGroup,linkType=value, possibility=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
isSelected Boolean 0..1 if True signifies that this link is considered certain rather than merely probable. This allows the selection of links without removing the accumulated probability information. All other ResonanceGroupProbs with the same linkType and sequenceOffset (but only those) are then considered incorrect.  
linkType LinkType 1..1 Type of link between fromResonanceGroup and possibility  
sequenceOffset Int 1..1 The number of residues distant that the possibility is from the fromResonanceGroup. If it is thought that fromResonanceGroup is e.g. Ala-39 and possibility is Thr-38, the correct value for sequenceOffset is -1.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedNameweight

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
fromResonanceGroup ResonanceGroup 1..1 (Parent link). ResonanceGroup owning the ResonanceGroup link probability  
parent ResonanceGroup 1..1 link to parent object - synonym for fromResonanceGroup  
possibility ResonanceGroup 1..1 Resonance group whose link probability is described.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
isSelected
getIsSelected Boolean -
setIsSelected - Boolean
linkType
getLinkType LinkType -
setLinkType - LinkType
sequenceOffset
getSequenceOffset Int -
setSequenceOffset - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
fromResonanceGroup
getFromResonanceGroup ResonanceGroup -
parent
getParent ResonanceGroup -
possibility
getPossibility ResonanceGroup -
setPossibility - ResonanceGroup

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ResonanceGroupProb 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_00035

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

identity_requires_offest_0
Constraint code: self.linkType != 'identity' or self.sequenceOffset == 0

Constraint name:

sequential_requires_offset_nonzero
Constraint code: self.linkType != 'sequential' or self.sequenceOffset != 0
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.ResonanceGroupProb   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk