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

Class: Method


    Description of method or procedure, be it computational (calculation or processing) or real-world (e.g. purification).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link methodStore to class MethodStore
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link parameters to class Parameter
Constructor: newObj = Method( methodStore, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
name Line 0..1 Method name  
procedure String 0..1 Description of the procedure carried out. Typically in the form of a script executable by the relevant Software, but could be a more general 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  
task Line 0..1 Operation caried out or result calculated e.g. 'Peak intensity', 'T1 fit', 'NMR processing', 'linear prediction', 'HPLC purification'.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
citations ccp.api.general.Citation.Citation 0..* Citations describing method.  
columns ccp.api.general.Instrument.Column 0..* Columns that use this loading method.  
compressDataSources ccp.api.nmr.Nmr.DataSource 0..* Nmr DataSources compresed with Method  
constraintLists ccp.api.nmr.NmrConstraint.AbstractConstraintList 0..* ConstraintLists calculated using Method  
constraints ccp.api.nmr.NmrConstraint.AbstractConstraint 0..* Constraints calculated using Method  
dataDerivations ccp.api.nmr.Nmr.AbstractDataDerivation 0..* DataDerivations calculated using Method  
dataDims ccp.api.nmr.Nmr.AbstractDataDim 0..* Nmr DataDims linear predicted with Method  
derivedDataLists ccp.api.nmr.Nmr.DerivedDataList 0..* DerivedDataLists calculated using Method  
derivedNmrExperiments ccp.api.nmr.Nmr.Experiment 0..* Nmr.Experiments derived using Method  
experiments ccp.api.lims.Experiment.Experiment 0..* Experiment associated to a certain Method.  
fitPeakLists ccp.api.nmr.Nmr.PeakList 0..* Nmr Peak Lists using Method as default fitting method.  
instrument ccp.api.general.Instrument.Instrument 0..1 Instrument associated to a given method.  
intensPeakLists ccp.api.nmr.Nmr.PeakList 0..* PeakLists using Method as 'Preferred' peak intensity deternmination method.  
measurementLists ccp.api.nmr.Nmr.AbstractMeasurementList 0..* Measurement lists calculated using Method  
measurements ccp.api.nmr.Nmr.AbstractMeasurement 0..* Measurements calculated using Method  
methodStore MethodStore 1..1 (Parent link). parent link  
parameters Parameter 0..* (Child link). child link to class Parameter  
parent MethodStore 1..1 link to parent object - synonym for methodStore  
peakIntensities ccp.api.nmr.Nmr.PeakIntensity 0..* Peak intensities determined using Method.  
peaks ccp.api.nmr.Nmr.Peak 0..* Peaks fitted using Method  
processDataSources ccp.api.nmr.Nmr.DataSource 0..* Nmr DataSources processed with Method.  
snDataSources ccp.api.nmr.Nmr.DataSource 0..* DataSources that use this method for S/N ratio determination  
software Software 0..1 Software used to execute method. Method.procedure will frequently be a script directly executable by the Software.  
structureAnalyses ccp.api.nmr.Nmr.StructureAnalysis 0..* StructureAnalyses carried out using method  
structureGenerations ccp.api.nmr.Nmr.StructureGeneration 0..* StructureGenerations carried out using method  
violations ccp.api.nmr.NmrConstraint.Violation 0..* Nmr Constraint violations calculated using Method  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
name
getName Line -
setName - Line
procedure
getProcedure String -
setProcedure - String
serial
getSerial Int -
setSerial - Int
task
getTask Line -
setTask - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
citations
getCitations ccp.api.general.Citation.Citation Set -
setCitations - ccp.api.general.Citation.Citation Set
sortedCitations ccp.api.general.Citation.Citation List -
findFirstCitation ccp.api.general.Citation.Citation keyword=value pairs
findAllCitations ccp.api.general.Citation.Citation Set keyword=value pairs
columns
getColumns ccp.api.general.Instrument.Column Set -
setColumns - ccp.api.general.Instrument.Column Set
sortedColumns ccp.api.general.Instrument.Column List -
addColumn - ccp.api.general.Instrument.Column
removeColumn - ccp.api.general.Instrument.Column
findFirstColumn ccp.api.general.Instrument.Column keyword=value pairs
findAllColumns ccp.api.general.Instrument.Column Set keyword=value pairs
compressDataSources
getCompressDataSources ccp.api.nmr.Nmr.DataSource Set -
setCompressDataSources - ccp.api.nmr.Nmr.DataSource Set
sortedCompressDataSources ccp.api.nmr.Nmr.DataSource List -
findFirstCompressDataSource ccp.api.nmr.Nmr.DataSource keyword=value pairs
findAllCompressDataSources ccp.api.nmr.Nmr.DataSource Set keyword=value pairs
constraintLists
getConstraintLists ccp.api.nmr.NmrConstraint.AbstractConstraintList Set -
setConstraintLists - ccp.api.nmr.NmrConstraint.AbstractConstraintList Set
sortedConstraintLists ccp.api.nmr.NmrConstraint.AbstractConstraintList List -
findFirstConstraintList ccp.api.nmr.NmrConstraint.AbstractConstraintList keyword=value pairs
findAllConstraintLists ccp.api.nmr.NmrConstraint.AbstractConstraintList Set keyword=value pairs
constraints
getConstraints ccp.api.nmr.NmrConstraint.AbstractConstraint Set -
setConstraints - ccp.api.nmr.NmrConstraint.AbstractConstraint Set
sortedConstraints ccp.api.nmr.NmrConstraint.AbstractConstraint List -
findFirstConstraint ccp.api.nmr.NmrConstraint.AbstractConstraint keyword=value pairs
findAllConstraints ccp.api.nmr.NmrConstraint.AbstractConstraint Set keyword=value pairs
dataDerivations
getDataDerivations ccp.api.nmr.Nmr.AbstractDataDerivation Set -
setDataDerivations - ccp.api.nmr.Nmr.AbstractDataDerivation Set
sortedDataDerivations ccp.api.nmr.Nmr.AbstractDataDerivation List -
findFirstDataDerivation ccp.api.nmr.Nmr.AbstractDataDerivation keyword=value pairs
findAllDataDerivations ccp.api.nmr.Nmr.AbstractDataDerivation Set keyword=value pairs
dataDims
getDataDims ccp.api.nmr.Nmr.AbstractDataDim Set -
setDataDims - ccp.api.nmr.Nmr.AbstractDataDim Set
sortedDataDims ccp.api.nmr.Nmr.AbstractDataDim List -
findFirstDataDim ccp.api.nmr.Nmr.AbstractDataDim keyword=value pairs
findAllDataDims ccp.api.nmr.Nmr.AbstractDataDim Set keyword=value pairs
derivedDataLists
getDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList Set -
setDerivedDataLists - ccp.api.nmr.Nmr.DerivedDataList Set
sortedDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList List -
findFirstDerivedDataList ccp.api.nmr.Nmr.DerivedDataList keyword=value pairs
findAllDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList Set keyword=value pairs
derivedNmrExperiments
getDerivedNmrExperiments ccp.api.nmr.Nmr.Experiment Set -
setDerivedNmrExperiments - ccp.api.nmr.Nmr.Experiment Set
sortedDerivedNmrExperiments ccp.api.nmr.Nmr.Experiment List -
addDerivedNmrExperiment - ccp.api.nmr.Nmr.Experiment
removeDerivedNmrExperiment - ccp.api.nmr.Nmr.Experiment
findFirstDerivedNmrExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllDerivedNmrExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
experiments
getExperiments ccp.api.lims.Experiment.Experiment Set -
setExperiments - ccp.api.lims.Experiment.Experiment Set
sortedExperiments ccp.api.lims.Experiment.Experiment List -
addExperiment - ccp.api.lims.Experiment.Experiment
removeExperiment - ccp.api.lims.Experiment.Experiment
findFirstExperiment ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllExperiments ccp.api.lims.Experiment.Experiment Set keyword=value pairs
fitPeakLists
getFitPeakLists ccp.api.nmr.Nmr.PeakList Set -
setFitPeakLists - ccp.api.nmr.Nmr.PeakList Set
sortedFitPeakLists ccp.api.nmr.Nmr.PeakList List -
addFitPeakList - ccp.api.nmr.Nmr.PeakList
removeFitPeakList - ccp.api.nmr.Nmr.PeakList
findFirstFitPeakList ccp.api.nmr.Nmr.PeakList keyword=value pairs
findAllFitPeakLists ccp.api.nmr.Nmr.PeakList Set keyword=value pairs
instrument
getInstrument ccp.api.general.Instrument.Instrument -
setInstrument - ccp.api.general.Instrument.Instrument
intensPeakLists
getIntensPeakLists ccp.api.nmr.Nmr.PeakList Set -
setIntensPeakLists - ccp.api.nmr.Nmr.PeakList Set
sortedIntensPeakLists ccp.api.nmr.Nmr.PeakList List -
addIntensPeakList - ccp.api.nmr.Nmr.PeakList
removeIntensPeakList - ccp.api.nmr.Nmr.PeakList
findFirstIntensPeakList ccp.api.nmr.Nmr.PeakList keyword=value pairs
findAllIntensPeakLists ccp.api.nmr.Nmr.PeakList Set keyword=value pairs
measurementLists
getMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set -
setMeasurementLists - ccp.api.nmr.Nmr.AbstractMeasurementList Set
sortedMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList List -
findFirstMeasurementList ccp.api.nmr.Nmr.AbstractMeasurementList keyword=value pairs
findAllMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set keyword=value pairs
measurements
getMeasurements ccp.api.nmr.Nmr.AbstractMeasurement Set -
setMeasurements - ccp.api.nmr.Nmr.AbstractMeasurement Set
sortedMeasurements ccp.api.nmr.Nmr.AbstractMeasurement List -
findFirstMeasurement ccp.api.nmr.Nmr.AbstractMeasurement keyword=value pairs
findAllMeasurements ccp.api.nmr.Nmr.AbstractMeasurement Set keyword=value pairs
methodStore
getMethodStore MethodStore -
parameters
getParameters Parameter Set -
sortedParameters Parameter List -
findFirstParameter Parameter keyword=value pairs
findAllParameters Parameter Set keyword=value pairs
parent
getParent MethodStore -
peakIntensities
getPeakIntensities ccp.api.nmr.Nmr.PeakIntensity Set -
setPeakIntensities - ccp.api.nmr.Nmr.PeakIntensity Set
sortedPeakIntensities ccp.api.nmr.Nmr.PeakIntensity List -
findFirstPeakIntensity ccp.api.nmr.Nmr.PeakIntensity keyword=value pairs
findAllPeakIntensities ccp.api.nmr.Nmr.PeakIntensity Set keyword=value pairs
peaks
getPeaks ccp.api.nmr.Nmr.Peak Set -
setPeaks - ccp.api.nmr.Nmr.Peak Set
sortedPeaks ccp.api.nmr.Nmr.Peak List -
addPeak - ccp.api.nmr.Nmr.Peak
removePeak - ccp.api.nmr.Nmr.Peak
findFirstPeak ccp.api.nmr.Nmr.Peak keyword=value pairs
findAllPeaks ccp.api.nmr.Nmr.Peak Set keyword=value pairs
processDataSources
getProcessDataSources ccp.api.nmr.Nmr.DataSource Set -
setProcessDataSources - ccp.api.nmr.Nmr.DataSource Set
sortedProcessDataSources ccp.api.nmr.Nmr.DataSource List -
findFirstProcessDataSource ccp.api.nmr.Nmr.DataSource keyword=value pairs
findAllProcessDataSources ccp.api.nmr.Nmr.DataSource Set keyword=value pairs
snDataSources
getSnDataSources ccp.api.nmr.Nmr.DataSource Set -
setSnDataSources - ccp.api.nmr.Nmr.DataSource Set
sortedSnDataSources ccp.api.nmr.Nmr.DataSource List -
addSnDataSource - ccp.api.nmr.Nmr.DataSource
removeSnDataSource - ccp.api.nmr.Nmr.DataSource
findFirstSnDataSource ccp.api.nmr.Nmr.DataSource keyword=value pairs
findAllSnDataSources ccp.api.nmr.Nmr.DataSource Set keyword=value pairs
software
getSoftware Software -
setSoftware - Software
structureAnalyses
getStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis Set -
setStructureAnalyses - ccp.api.nmr.Nmr.StructureAnalysis Set
sortedStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis List -
addStructureAnalysis - ccp.api.nmr.Nmr.StructureAnalysis
removeStructureAnalysis - ccp.api.nmr.Nmr.StructureAnalysis
findFirstStructureAnalysis ccp.api.nmr.Nmr.StructureAnalysis keyword=value pairs
findAllStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis Set keyword=value pairs
structureGenerations
getStructureGenerations ccp.api.nmr.Nmr.StructureGeneration Set -
setStructureGenerations - ccp.api.nmr.Nmr.StructureGeneration Set
sortedStructureGenerations ccp.api.nmr.Nmr.StructureGeneration List -
addStructureGeneration - ccp.api.nmr.Nmr.StructureGeneration
removeStructureGeneration - ccp.api.nmr.Nmr.StructureGeneration
findFirstStructureGeneration ccp.api.nmr.Nmr.StructureGeneration keyword=value pairs
findAllStructureGenerations ccp.api.nmr.Nmr.StructureGeneration Set keyword=value pairs
violations
getViolations ccp.api.nmr.NmrConstraint.Violation Set -
setViolations - ccp.api.nmr.NmrConstraint.Violation Set
sortedViolations ccp.api.nmr.NmrConstraint.Violation List -
findFirstViolation ccp.api.nmr.NmrConstraint.Violation keyword=value pairs
findAllViolations ccp.api.nmr.NmrConstraint.Violation Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Method 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
newParameter Parameter name, ...

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:25:09_00028

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