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

Class: ExpDim


    Dimension of Experiment
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link experiment to class Experiment
Main key: dim
Mandatory Attributes: dim
Known Subclasses: None
Children:
link expDimRefs to class ExpDimRef
Constructor: newObj = ExpDim( experiment,dim=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dim PositiveInt 1..1 Dimension number. Dimensions go from one to numDim. It is recommended that dimensions are numbered in order of storage, so that dimension numDim has the slowest varying index, and that dim 1 should be the acquisition dimension, but programs should not rely on this.  
isAcquisition Boolean 1..1 If true the relevant dimension is the acquisition dimension.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataDims AbstractDataDim 0..* DataDims corresponding to ExpDim.  
expDimRefs ExpDimRef 0..* (Child link). child link  
experiment Experiment 1..1 (Parent link). parent link  
parent Experiment 1..1 link to parent object - synonym for experiment  
refExpDim ccp.api.nmr.NmrExpPrototype.RefExpDim 0..1 Corresponding ExpDim in RefNmeExperiment  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dim
getDim PositiveInt -
setDim - PositiveInt
isAcquisition
getIsAcquisition Boolean -
setIsAcquisition - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dataDims
getDataDims AbstractDataDim Set -
setDataDims - AbstractDataDim Set
sortedDataDims AbstractDataDim List -
findFirstDataDim AbstractDataDim keyword=value pairs
findAllDataDims AbstractDataDim Set keyword=value pairs
expDimRefs
getExpDimRefs ExpDimRef Set -
sortedExpDimRefs ExpDimRef List -
findFirstExpDimRef ExpDimRef keyword=value pairs
findAllExpDimRefs ExpDimRef Set keyword=value pairs
experiment
getExperiment Experiment -
parent
getParent Experiment -
refExpDim
getRefExpDim ccp.api.nmr.NmrExpPrototype.RefExpDim -
setRefExpDim - ccp.api.nmr.NmrExpPrototype.RefExpDim

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ExpDim 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
newExpDimRef ExpDimRef sf, ...

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_00026

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.ExpDim   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk