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

Class: PeakList

The PeakList destructor includes non-standard actions.
    List of Peaks, all belonging to a specific DataSource.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link dataSource to class DataSource
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link peaks to class Peak
Constructor: newObj = PeakList( dataSource, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
isSimulated Boolean 1..1 Are the peaks calculated rather than measured?  
name Line 0..1 Name of peaklist. Used in e.g. annotation to distinguish the peaklist from others belonging to the same dataSource.  
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
analysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout 0..* AnalysisLayouts referring to PeakLists  
analysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel 0..* AnalysisPanels referring to PeakLists  
analysisPeakList ccpnmr.api.Analysis.AnalysisPeakList 0..1 Analysis PeakList object associated with PeakList  
analysisPeakLists ccpnmr.api.AnalysisV3.AnalysisPeakList 0..*  
dataSource DataSource 1..1 (Parent link). parent link  
entries ccp.api.nmr.NmrEntry.Entry 0..* Nmr Entries that make use of PeakList  
fitMethod ccp.api.general.Method.Method 0..1 Default fitting method for peaks in peakList. Valid for any peak that does not have an explicit fititng method.  
intensMethod ccp.api.general.Method.Method 0..1 'Preferred' intensity determination method for peakList, the method whose results should be mostly relied on by others.  
parent DataSource 1..1 link to parent object - synonym for dataSource  
peakListValidations ccp.api.molecule.Validation.PeakListValidation 0..* Validation result that include PeakLists  
peaks Peak 0..* (Child link). child link to class Peak  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
isSimulated
getIsSimulated Boolean -
setIsSimulated - Boolean
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisLayouts
getAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set -
setAnalysisLayouts - ccpnmr.api.AnalysisV3.AnalysisLayout Set
sortedAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout List -
addAnalysisLayout - ccpnmr.api.AnalysisV3.AnalysisLayout
removeAnalysisLayout - ccpnmr.api.AnalysisV3.AnalysisLayout
findFirstAnalysisLayout ccpnmr.api.AnalysisV3.AnalysisLayout keyword=value pairs
findAllAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set keyword=value pairs
analysisPanels
getAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel Set -
setAnalysisPanels - ccpnmr.api.AnalysisV3.AnalysisPanel Set
sortedAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel List -
addAnalysisPanel - ccpnmr.api.AnalysisV3.AnalysisPanel
removeAnalysisPanel - ccpnmr.api.AnalysisV3.AnalysisPanel
findFirstAnalysisPanel ccpnmr.api.AnalysisV3.AnalysisPanel keyword=value pairs
findAllAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel Set keyword=value pairs
analysisPeakList
getAnalysisPeakList ccpnmr.api.Analysis.AnalysisPeakList -
setAnalysisPeakList - ccpnmr.api.Analysis.AnalysisPeakList
analysisPeakLists
getAnalysisPeakLists ccpnmr.api.AnalysisV3.AnalysisPeakList Set -
setAnalysisPeakLists - ccpnmr.api.AnalysisV3.AnalysisPeakList Set
sortedAnalysisPeakLists ccpnmr.api.AnalysisV3.AnalysisPeakList List -
findFirstAnalysisPeakList ccpnmr.api.AnalysisV3.AnalysisPeakList keyword=value pairs
findAllAnalysisPeakLists ccpnmr.api.AnalysisV3.AnalysisPeakList Set keyword=value pairs
dataSource
getDataSource DataSource -
entries
getEntries ccp.api.nmr.NmrEntry.Entry Set -
setEntries - ccp.api.nmr.NmrEntry.Entry Set
sortedEntries ccp.api.nmr.NmrEntry.Entry List -
addEntry - ccp.api.nmr.NmrEntry.Entry
removeEntry - ccp.api.nmr.NmrEntry.Entry
findFirstEntry ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllEntries ccp.api.nmr.NmrEntry.Entry Set keyword=value pairs
fitMethod
getFitMethod ccp.api.general.Method.Method -
setFitMethod - ccp.api.general.Method.Method
intensMethod
getIntensMethod ccp.api.general.Method.Method -
setIntensMethod - ccp.api.general.Method.Method
parent
getParent DataSource -
peakListValidations
getPeakListValidations ccp.api.molecule.Validation.PeakListValidation Set -
setPeakListValidations - ccp.api.molecule.Validation.PeakListValidation Set
sortedPeakListValidations ccp.api.molecule.Validation.PeakListValidation List -
addPeakListValidation - ccp.api.molecule.Validation.PeakListValidation
removePeakListValidation - ccp.api.molecule.Validation.PeakListValidation
findFirstPeakListValidation ccp.api.molecule.Validation.PeakListValidation keyword=value pairs
findAllPeakListValidations ccp.api.molecule.Validation.PeakListValidation Set keyword=value pairs
peaks
getPeaks Peak Set -
sortedPeaks Peak List -
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 PeakList 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
newPeak Peak ...

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_00022

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

if self is self.dataSource.activePeakList:
  self.dataSource.activePeakList = None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: ccp.api.nmr.Nmr.DataSource.activePeakListccp.api.nmr.NmrCalc.PeakListData.peakList
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:30 2014    from data model package  ccp.api.nmr.Nmr.PeakList   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk