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

Class: NmrExpPrototype


    Description of a reference NMR experiment as defined by its magnetisation transfer pathway. E.g. a 4D HCCH, 3D (H)CCH or HC(C)H, 2D H(C)(C)H and 2D (reduced dimensionality) HC(C)H are seen as the same experiment
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class memops.api.Implementation.MemopsRoot
Main key: serial
Mandatory Attributes: category, name
Partitions Children: True
Known Subclasses: None
Children:
link atomSites to class AtomSite
link expGraphs to class ExpGraph
link expMeasurements to class ExpMeasurement
link refExperiments to class RefExperiment
Constructor: newObj = NmrExpPrototype( memopsRoot,category=value, name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
category ExpCategory 1..1 Experiment category. See datatype for details  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
keywords ExpKeyword 0..* keywords to characterise the type and uses of experiment in more detail than permitted by 'category'. Examples would be 'protein', 'sidechain', 'backbone', 'filtered', 'T1', 'RDC', ...  
name Line 1..1 name of experiment prototype  
priority PositiveInt 1..1 Experiment priority. Serves to classify experiments for display so that the more common can be more prominently displayed. Intended use would be 1=high, 2=medium, 3=low priority.  
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  
synonym Line 0..1 Alternative name of NmrExpPrototype. Used for experiments with well-established non-systematic name.  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomSites AtomSite 0..* (Child link). child link to class AtomSite  
expGraphs ExpGraph 0..* (Child link). child link to class ExpGraph  
expMeasurements ExpMeasurement 0..* (Child link). child link to class ExpMeasurement  
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
refExperiments RefExperiment 0..* (Child link). child link to class RefExperiment  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
category
getCategory ExpCategory -
setCategory - ExpCategory
details
getDetails Text -
setDetails - Text
keywords
getKeywords ExpKeyword Tuple -
setKeywords - ExpKeyword List
addKeyword - ExpKeyword
removeKeyword - ExpKeyword
name
getName Line -
setName - Line
priority
getPriority PositiveInt -
setPriority - PositiveInt
serial
getSerial Int -
setSerial - Int
synonym
getSynonym Line -
setSynonym - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomSites
getAtomSites AtomSite Set -
sortedAtomSites AtomSite List -
findFirstAtomSite AtomSite keyword=value pairs
findAllAtomSites AtomSite Set keyword=value pairs
expGraphs
getExpGraphs ExpGraph Set -
sortedExpGraphs ExpGraph List -
findFirstExpGraph ExpGraph keyword=value pairs
findAllExpGraphs ExpGraph Set keyword=value pairs
expMeasurements
getExpMeasurements ExpMeasurement Set -
sortedExpMeasurements ExpMeasurement List -
findFirstExpMeasurement ExpMeasurement keyword=value pairs
findAllExpMeasurements ExpMeasurement Set keyword=value pairs
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
parent
getParent memops.api.Implementation.MemopsRoot -
refExperiments
getRefExperiments RefExperiment Set -
sortedRefExperiments RefExperiment List -
findFirstRefExperiment RefExperiment keyword=value pairs
findAllRefExperiments RefExperiment Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NmrExpPrototype memops.api.Implementation.MemopsRoot, 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
newAtomSite AtomSite isotopeCode, ...
newExpGraph ExpGraph ...
newExpMeasurement ExpMeasurement ...
newRefExperiment RefExperiment ...

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:45_00020

isImplicit:

False

Tag

Value
repositoryId $Id: NmrExpPrototype.xml,v 1.50 2011-01-13 14:40:36 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: memops.api.Implementation.MemopsRoot.currentNmrExpPrototype
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:21 2013    from data model package  ccp.api.nmr.NmrExpPrototype.NmrExpPrototype   revision 1.50  
  Work done by the CCPN team.
www.ccpn.ac.uk