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

Class: NmrExpSeries


    Series of Nmr experiments varying some variable. E.g. titration series, temperature series, T1 measurement.
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: conditionNames
Known Subclasses: None
Children: None
Constructor: newObj = NmrExpSeries( nmrProject,conditionNames=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
conditionNames SampleConditionType 1..* The variables that are changing from experiment to experiment in the NmrExpSeries. The variableNames must match a SampleCondition.condition.  
details Text 0..1 Extra information about the variable being varied between experiments. if variableName is 'concentration', variableDescriptor gives the name of the species whose concentration is being monitored. If variableDescriptor matches a SampleComponent.AbstractComponent.name it can be assumed that this is the sampleComponent is being referred to. Another example would be a hydrogen exchange series, where you would use variableName = 'time', variableDescriptor 'hydrogen exchange', or a T1 experiment, where you would use variableName='time', variableDescriptor 'T1 relaxation'  
name Line 0..1 name of NmrExpSeries - serves as a human readable identifier  
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
experiments Experiment 0..* Experiments that make up experiment series  
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
conditionNames
getConditionNames SampleConditionType Tuple -
setConditionNames - SampleConditionType List
addConditionName - SampleConditionType
removeConditionName - SampleConditionType
details
getDetails Text -
setDetails - Text
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
experiments
getExperiments Experiment Tuple -
setExperiments - Experiment List
addExperiment - Experiment
removeExperiment - Experiment
findFirstExperiment Experiment keyword=value pairs
findAllExperiments Experiment List 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 NmrExpSeries 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:49_00010

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  Thu Oct 2 16:09:37 2014    from data model package  ccp.api.nmr.Nmr.NmrExpSeries   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk