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

Class: PeakDimContrib

The PeakDimContrib constructor includes non-standard actions.
    PeakDimContrib for parameters assigned to a single Resonance (the normal case).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link peakDim to class PeakDim
Main key: serial
Mandatory Attributes: peakContribs, resonance
Known Subclasses: None
Children: None
Constructor: newObj = PeakDimContrib( peakDim,peakContribs=value, resonance=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dim Int 1..1 Derived. Dimension number of PeakDimContrib  
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
parent PeakDim 1..1 link to parent object - synonym for peakDim  
peakContribs PeakContrib 1..* PeakContribs(s) within which the PeakDimContrib are possible assignments  
peakDim PeakDim 1..1 (Parent link). parent link  
peakDimComponent PeakDimComponent 0..1 PeakDimComponent to which this AbstractPeakDimContrib is attached. if it is attached to none, it belongs instead to teh main assignment component of the peak.  
resonance Resonance 1..1 Resonance assigned to PeakDimContrib  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dim
getDim Int - non-std.
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parent
getParent PeakDim -
peakContribs
getPeakContribs PeakContrib Set -
setPeakContribs - PeakContrib Set
sortedPeakContribs PeakContrib List -
addPeakContrib - PeakContrib
removePeakContrib - PeakContrib
findFirstPeakContrib PeakContrib keyword=value pairs
findAllPeakContribs PeakContrib Set keyword=value pairs
peakDim
getPeakDim PeakDim -
peakDimComponent
getPeakDimComponent PeakDimComponent -
setPeakDimComponent - PeakDimComponent
resonance
getResonance Resonance -
setResonance - Resonance

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey PeakDimContrib 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:48_00026

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

if not self.peakContribs:
  possPeakContribs = self.peakDim.peak.peakContribs
  
  if not possPeakContribs:
    self.peakContribs = (PeakContrib(self.peakDim.peak),)
  
  elif len(possPeakContribs) == 1:
    self.peakContribs = possPeakContribs
  
  else:
    raise ApiError("PeakDimContrib must have a peakContribs input parameter where the peak has more than one possibility")

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

resonance_and_peakDimComponent_form_secondary_key_for_PeakDimContrib
Constraint code: # NB left in direct access for speed reasons only
for obj in dataDict['peakDim'].findAllPeakDimContribs(resonance=dataDict['resonance'], peakDimComponent=dataDict['peakDimComponent']):
  if obj is not self:
    isValid = False
    break
else:
  isValid = True
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:58 2015    from data model package  ccp.api.nmr.Nmr.PeakDimContrib   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk