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

Class: NmrSpectrometer


    Nmr Spectrometer used for data acquisition during a Project.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link instrumentStore to class InstrumentStore
Main key: serial
Mandatory Attributes: name
Known Subclasses: None
Children: None
Constructor: newObj = NmrSpectrometer( instrumentStore,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
instrumentType Line 1..1 Instrument type - must be left as the default 'NmrSpectrometer'  
model Line 0..1 The model of the instrument.  
name Line 1..1 The name of the instrument.  
nominalFreq SpectrometerFreq 0..1 Nominal rounded-off spectrometer frequency in MHz protons, given as a string.  
protonFreq Float 0..1 Actual magnet field strength expressed as the proton resonance frequency in MHz. e.g. '500.013'.  
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  
serialNumber Line 0..1 Instrument 'serial number'. A string that uniquely identifies a given instrument.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
citations ccp.api.general.Citation.Citation 0..* Citations describing Nmr Spectrometer.  
contactPerson ccp.api.general.Affiliation.Person 0..1 This is the contact person in the company.  
experiments ccp.api.nmr.Nmr.Experiment 0..* Nmr Experiments carried out on spectrometer.  
instrumentStore InstrumentStore 1..1 (Parent link). parent link  
manufacturer ccp.api.general.Affiliation.Organisation 0..1 The name of the manufacturer of the instrument.  
parent InstrumentStore 1..1 link to parent object - synonym for instrumentStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
instrumentType
getInstrumentType Line -
setInstrumentType - Line
model
getModel Line -
setModel - Line
name
getName Line -
setName - Line
nominalFreq
getNominalFreq SpectrometerFreq -
setNominalFreq - SpectrometerFreq
protonFreq
getProtonFreq Float -
setProtonFreq - Float
serial
getSerial Int -
setSerial - Int
serialNumber
getSerialNumber Line -
setSerialNumber - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
citations
getCitations ccp.api.general.Citation.Citation Set -
setCitations - ccp.api.general.Citation.Citation Set
sortedCitations ccp.api.general.Citation.Citation List -
findFirstCitation ccp.api.general.Citation.Citation keyword=value pairs
findAllCitations ccp.api.general.Citation.Citation Set keyword=value pairs
contactPerson
getContactPerson ccp.api.general.Affiliation.Person -
setContactPerson - ccp.api.general.Affiliation.Person
experiments
getExperiments ccp.api.nmr.Nmr.Experiment Set -
setExperiments - ccp.api.nmr.Nmr.Experiment Set
sortedExperiments ccp.api.nmr.Nmr.Experiment List -
addExperiment - ccp.api.nmr.Nmr.Experiment
removeExperiment - ccp.api.nmr.Nmr.Experiment
findFirstExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
instrumentStore
getInstrumentStore InstrumentStore -
manufacturer
getManufacturer ccp.api.general.Affiliation.Organisation -
setManufacturer - ccp.api.general.Affiliation.Organisation
parent
getParent InstrumentStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NmrSpectrometer 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:45_00040

isImplicit:

False

Tag

Value
repositoryId $Id: NmrSpectrometer.xml,v 1.49 2011-01-13 14:40:32 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: ccp.api.nmr.NmrEntry.Entry.nmrSpectrometers
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:28 2013    from data model package  ccp.api.general.Instrument.NmrSpectrometer   revision 1.49  
  Work done by the CCPN team.
www.ccpn.ac.uk