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

Class: NmrScreen

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: code
Mandatory Attributes: code
Partitions Children: True
Known Subclasses: None
Children:
link mixtures to class Mixture
link trialGroups to class TrialGroup
link trialSets to class TrialSet
Constructor: newObj = NmrScreen( memopsRoot,code=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 1..1 Short permanent identifier  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
endDate DateTime 0..1  
name Line 0..1 User-intelligible name  
objective Text 0..1 Purpose of NmrScreen  
pH Float 0..1 pH for all samples in NmrScreen. NB, it is up to users to make sure that all samples do in fact corrspond to this pH. If not set, pH values must be extracted form the Sample objects.  
refDataStoreNames Line 0..* Names of RefDataStores used for NmrScreen. Key for derived link refDataStores.  
sampleType Line 0..1 Type of sample, e.g. blood, rat liver, synthetic  
startDate DateTime 0..1  
temperature NonNegativeFloat 0..1 Temperature (in K) for all experiments in NmrScreen. NB, it is up to users to make sure that all experiments do in fact corrspond to this temperature. If not set, emperatures must be extracted form the DataSource experimental conditions.  
userProtocolCode Line 0..1 User protocol identifier, referring to external protocol specification.  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
mixtures Mixture 0..* (Child link). child link to class Mixture  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
refDataStores ccp.api.lims.RefData.RefDataStore 0..* Derived. RefDataStores storing reference spectra for NmrScreen. Ordered. The order of the RefDataStores is used as the search order, when RefNmrSpectra and RefSampleComponents are looked up by componentName.  
target ccp.api.molecule.MolSystem.MolSystem 0..1  
trialGroups TrialGroup 0..* (Child link). child link to class TrialGroup  
trialSets TrialSet 0..* (Child link). child link to class TrialSet  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Word -
setCode - Word
details
getDetails Text -
setDetails - Text
endDate
getEndDate DateTime -
setEndDate - DateTime
name
getName Line -
setName - Line
objective
getObjective Text -
setObjective - Text
pH
getPH Float -
setPH - Float
refDataStoreNames
getRefDataStoreNames Line Tuple -
setRefDataStoreNames - Line List
addRefDataStoreName - Line
removeRefDataStoreName - Line
sampleType
getSampleType Line -
setSampleType - Line
startDate
getStartDate DateTime -
setStartDate - DateTime
temperature
getTemperature NonNegativeFloat -
setTemperature - NonNegativeFloat
userProtocolCode
getUserProtocolCode Line -
setUserProtocolCode - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
mixtures
getMixtures Mixture Set -
sortedMixtures Mixture List -
findFirstMixture Mixture keyword=value pairs
findAllMixtures Mixture Set keyword=value pairs
parent
getParent memops.api.Implementation.MemopsRoot -
refDataStores
getRefDataStores ccp.api.lims.RefData.RefDataStore Tuple - non-std.
setRefDataStores - ccp.api.lims.RefData.RefDataStore List non-std.
addRefDataStore - ccp.api.lims.RefData.RefDataStore
removeRefDataStore - ccp.api.lims.RefData.RefDataStore
findFirstRefDataStore ccp.api.lims.RefData.RefDataStore keyword=value pairs
findAllRefDataStores ccp.api.lims.RefData.RefDataStore List keyword=value pairs
target
getTarget ccp.api.molecule.MolSystem.MolSystem -
setTarget - ccp.api.molecule.MolSystem.MolSystem
trialGroups
getTrialGroups TrialGroup Set -
sortedTrialGroups TrialGroup List -
findFirstTrialGroup TrialGroup keyword=value pairs
findAllTrialGroups TrialGroup Set keyword=value pairs
trialSets
getTrialSets TrialSet Set -
sortedTrialSets TrialSet List -
findFirstTrialSet TrialSet keyword=value pairs
findAllTrialSets TrialSet Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NmrScreen 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
newMixture Mixture ...
newTrialGroup TrialGroup ...
newTrialSet TrialSet ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2009-11-19-14:50:32_00006

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: memops.api.Implementation.MemopsRoot.currentNmrScreen
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:51 2014    from data model package  ccp.api.nmr.NmrScreen.NmrScreen   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk