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

Class: DipolarRelaxList


    List of dipole-dipole relaxation measurements.
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: None
Known Subclasses: None
Children:
link measurements to class DipolarRelaxation
Constructor: newObj = DipolarRelaxList( nmrProject, ... )

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 data in this list simulated? The attribute is an annotation more than anything else, as there are no corresponding constraints.  
name Line 0..1 Measurement List name, freely chosen by user. Intended to identify the list from other lists of the same type.  
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  
sf Float 0..1 Spectrometer frequency in MHz at which dipole-dipole relaxation was measured.  
unit Word 1..1 Unit of measurement for Dipolar relaxation contributions - default 'Hz'.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
entries ccp.api.nmr.NmrEntry.Entry 0..* Bmrb Entries for MeasurementList  
experiments Experiment 0..* Experiments for which dipole-diploe relaxation list is valid  
measurements DipolarRelaxation 0..* (Child link). child link to class DipolarRelaxation  
method ccp.api.general.Method.Method 0..1 Default method used to calculate measurements. May be overridden for individual measurements in the list.  
nmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation 0..* Validation results that include AbstractMeasurementList  
nmrProject NmrProject 1..1 (Parent link). parent link  
parent NmrProject 1..1 link to parent object - synonym for nmrProject  

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
sf
getSf Float -
setSf - Float
unit
getUnit Word -
setUnit - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
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
experiments
getExperiments Experiment Set -
setExperiments - Experiment Set
sortedExperiments Experiment List -
addExperiment - Experiment
removeExperiment - Experiment
findFirstExperiment Experiment keyword=value pairs
findAllExperiments Experiment Set keyword=value pairs
measurements
getMeasurements DipolarRelaxation Set -
sortedMeasurements DipolarRelaxation List -
findFirstMeasurement DipolarRelaxation keyword=value pairs
findAllMeasurements DipolarRelaxation Set keyword=value pairs
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
nmrMeasurementListValidations
getNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation Set -
setNmrMeasurementListValidations - ccp.api.molecule.Validation.NmrMeasurementListValidation Set
sortedNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation List -
addNmrMeasurementListValidation - ccp.api.molecule.Validation.NmrMeasurementListValidation
removeNmrMeasurementListValidation - ccp.api.molecule.Validation.NmrMeasurementListValidation
findFirstNmrMeasurementListValidation ccp.api.molecule.Validation.NmrMeasurementListValidation keyword=value pairs
findAllNmrMeasurementListValidations ccp.api.molecule.Validation.NmrMeasurementListValidation Set keyword=value pairs
nmrProject
getNmrProject NmrProject -
parent
getParent NmrProject -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey DipolarRelaxList 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
newDipolarRelaxation DipolarRelaxation value, resonances, ...

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:46_00024

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