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

Class: PeakCluster


    Cluster of peaks that together make up a (nD) multiplet. The peaks may come from different PeakLists and Experiments.
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: clusterType
Known Subclasses: None
Children: None
Constructor: newObj = PeakCluster( nmrProject,clusterType=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annotation Line 0..1 Peak Cluster annotation. Short descriptive information, which may be used on screen displays of spectra with peaks.  
clusterType PeakClusterType 1..1 Type of cluster - see datatype documentation for possible types and their meanings. There are no constraints that depend on the type, but applications may apply different treatment to different types of clusters.  
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
nmrProject NmrProject 1..1 (Parent link). parent link  
parent NmrProject 1..1 link to parent object - synonym for nmrProject  
peaks Peak 0..* Peaks that make up the peakCluster  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annotation
getAnnotation Line -
setAnnotation - Line
clusterType
getClusterType PeakClusterType -
setClusterType - PeakClusterType
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
nmrProject
getNmrProject NmrProject -
parent
getParent NmrProject -
peaks
getPeaks Peak Set -
setPeaks - Peak Set
sortedPeaks Peak List -
addPeak - Peak
removePeak - Peak
findFirstPeak Peak keyword=value pairs
findAllPeaks Peak Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey PeakCluster 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-10-25-11:29:42_00002

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:29 2014    from data model package  ccp.api.nmr.Nmr.PeakCluster   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk