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

Class: Instrument


    Instrument used.
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: Column
Children: None
Constructor: newObj = Instrument( 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 0..1 The type of the instrument. Should be an open enumeration.  
model Line 0..1 The model of the instrument.  
name Line 1..1 The name of the instrument.  
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
contactPerson ccp.api.general.Affiliation.Person 0..1 This is the contact person in the company.  
experiments ccp.api.lims.Experiment.Experiment 0..* Experiments carried out using Instrument.  
instrumentStore InstrumentStore 1..1 (Parent link). parent link  
instrumentTypes ccp.api.lims.Classification.InstrumentType 0..* List of instrument type associated to an instrument.  
manufacturer ccp.api.general.Affiliation.Organisation 0..1 The name of the manufacturer of the instrument.  
methods ccp.api.general.Method.Method 0..* Methods implemented on a given 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
serial
getSerial Int -
setSerial - Int
serialNumber
getSerialNumber Line -
setSerialNumber - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
contactPerson
getContactPerson ccp.api.general.Affiliation.Person -
setContactPerson - ccp.api.general.Affiliation.Person
experiments
getExperiments ccp.api.lims.Experiment.Experiment Set -
setExperiments - ccp.api.lims.Experiment.Experiment Set
sortedExperiments ccp.api.lims.Experiment.Experiment List -
addExperiment - ccp.api.lims.Experiment.Experiment
removeExperiment - ccp.api.lims.Experiment.Experiment
findFirstExperiment ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllExperiments ccp.api.lims.Experiment.Experiment Set keyword=value pairs
instrumentStore
getInstrumentStore InstrumentStore -
instrumentTypes
getInstrumentTypes ccp.api.lims.Classification.InstrumentType Set -
setInstrumentTypes - ccp.api.lims.Classification.InstrumentType Set
sortedInstrumentTypes ccp.api.lims.Classification.InstrumentType List -
addInstrumentType - ccp.api.lims.Classification.InstrumentType
removeInstrumentType - ccp.api.lims.Classification.InstrumentType
findFirstInstrumentType ccp.api.lims.Classification.InstrumentType keyword=value pairs
findAllInstrumentTypes ccp.api.lims.Classification.InstrumentType Set keyword=value pairs
manufacturer
getManufacturer ccp.api.general.Affiliation.Organisation -
setManufacturer - ccp.api.general.Affiliation.Organisation
methods
getMethods ccp.api.general.Method.Method Set -
setMethods - ccp.api.general.Method.Method Set
sortedMethods ccp.api.general.Method.Method List -
addMethod - ccp.api.general.Method.Method
removeMethod - ccp.api.general.Method.Method
findFirstMethod ccp.api.general.Method.Method keyword=value pairs
findAllMethods ccp.api.general.Method.Method Set keyword=value pairs
parent
getParent InstrumentStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Instrument 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:46_00001

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  Thu Oct 2 16:09:18 2014    from data model package  ccp.api.general.Instrument.Instrument   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk