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

Class: RefExperiment


    Reference Experiment. Selects experiment dimensions from the steps available in the NmrExpPrototype
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrExpPrototype to class NmrExpPrototype
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link refExpDims to class RefExpDim
link systematicNames to class SystematicName
Constructor: newObj = RefExperiment( nmrExpPrototype, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
isReversed Boolean 1..1 Is experiment carried out with the transfer steps and sequence of ExpMeasurements in reverse order relative to the order given in the ExpGraphs?  
name Line 0..1 name of RefExperiment  
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 RefExperiment. Intended for longer, more precisely descriptive names. Dimensionality, if desired, should be given as a prefix separated by a dot, e.g. '3D.'. Detailed indications of transfer mechanisms (e.g. 'HSQC', 'HMQC', should be given in the same manner as other transfer mechanisms (like 'NOESY').  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
nmrExpPrototype NmrExpPrototype 1..1 (Parent link). parent link  
parent NmrExpPrototype 1..1 link to parent object - synonym for nmrExpPrototype  
refExpDims RefExpDim 0..* (Child link). child link to class RefExpDim  
systematicNames SystematicName 0..* (Child link). child link to class SystematicName  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
isReversed
getIsReversed Boolean -
setIsReversed - Boolean
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
synonym
getSynonym Line -
setSynonym - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
nmrExpPrototype
getNmrExpPrototype NmrExpPrototype -
parent
getParent NmrExpPrototype -
refExpDims
getRefExpDims RefExpDim Set -
sortedRefExpDims RefExpDim List -
findFirstRefExpDim RefExpDim keyword=value pairs
findAllRefExpDims RefExpDim Set keyword=value pairs
systematicNames
getSystematicNames SystematicName Set -
sortedSystematicNames SystematicName List -
findFirstSystematicName SystematicName keyword=value pairs
findAllSystematicNames SystematicName Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey RefExperiment 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
newRefExpDim RefExpDim dim, ...
newSystematicName SystematicName name, namingSystem, ...

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_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: ccp.api.nmr.Nmr.Experiment.refExperiment
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:10 2014    from data model package  ccp.api.nmr.NmrExpPrototype.RefExperiment   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk