Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes

Instrument Class Reference
[Metadata]

Description of a MS instrument. More...

#include <OpenMS/METADATA/Instrument.h>

Inheritance diagram for Instrument:
MetaInfoInterface

List of all members.

Public Types

enum  IonOpticsType {
  UNKNOWN, MAGNETIC_DEFLECTION, DELAYED_EXTRACTION, COLLISION_QUADRUPOLE,
  SELECTED_ION_FLOW_TUBE, TIME_LAG_FOCUSING, REFLECTRON, EINZEL_LENS,
  FIRST_STABILITY_REGION, FRINGING_FIELD, KINETIC_ENERGY_ANALYZER, STATIC_FIELD,
  SIZE_OF_IONOPTICSTYPE
}
 

ion optics type

More...

Public Member Functions

 Instrument ()
 Constructor.
 Instrument (const Instrument &source)
 Copy constructor.
 ~Instrument ()
 Destructor.
Instrument & operator= (const Instrument &source)
 Assignement operator.
bool operator== (const Instrument &rhs) const
 Equality operator.
bool operator!= (const Instrument &rhs) const
 Equality operator.
const String & getName () const
 returns the name of the instrument
void setName (const String &name)
 sets the name of the instrument
const String & getVendor () const
 returns the instrument vendor
void setVendor (const String &vendor)
 sets the instrument vendor
const String & getModel () const
 returns the instrument model
void setModel (const String &model)
 sets the instrument model
const String & getCustomizations () const
 returns a description of customizations
void setCustomizations (const String &customizations)
 sets the a description of customizations
const std::vector< IonSource > & getIonSources () const
 returns a const reference to the ion source list
std::vector< IonSource > & getIonSources ()
 returns a mutable reference to the ion source list
void setIonSources (const std::vector< IonSource > &ion_sources)
 sets the ion source list
const std::vector< MassAnalyzer > & getMassAnalyzers () const
 returns a const reference to the mass analyer list
std::vector< MassAnalyzer > & getMassAnalyzers ()
 returns a mutable reference to the mass analyzer list
void setMassAnalyzers (const std::vector< MassAnalyzer > &mass_analyzers)
 sets the mass analyzer list
const std::vector< IonDetector > & getIonDetectors () const
 returns a const reference to the ion detector list
std::vector< IonDetector > & getIonDetectors ()
 returns a mutable reference to the ion detector list
void setIonDetectors (const std::vector< IonDetector > &ion_detectors)
 sets the ion detector list
const Software & getSoftware () const
 returns a const reference to the instrument software
Software & getSoftware ()
 returns a mutable reference to the instrument software
void setSoftware (const Software &software)
 sets the instrument software
IonOpticsType getIonOptics () const
 returns the ion optics type
void setIonOptics (IonOpticsType ion_optics)
 sets the ion optics type

Static Public Attributes

static const std::string NamesOfIonOpticsType [SIZE_OF_IONOPTICSTYPE]
 Names of inlet types.

Protected Attributes

String name_
String vendor_
String model_
String customizations_
std::vector< IonSource > ion_sources_
std::vector< MassAnalyzer > mass_analyzers_
std::vector< IonDetector > ion_detectors_
Software software_
IonOpticsType ion_optics_

Detailed Description

Description of a MS instrument.

It contains information like vendor, model, ion source(s), mass analyzer(s), and ion detector(s).

The parts (IonSource, MassAnalyzer, IonDetector) all have a order member. The order can be ignored, as long the instrument has this default setup:

For more complex instuments, the order should be defined.

Member Enumeration Documentation

enum IonOpticsType

ion optics type

Enumerator:
UNKNOWN 

unknown

MAGNETIC_DEFLECTION 

magnetic deflection

DELAYED_EXTRACTION 

delayed extraction

COLLISION_QUADRUPOLE 

collision quadrupole

SELECTED_ION_FLOW_TUBE 

selected ion flow tube

TIME_LAG_FOCUSING 

time lag focusing

REFLECTRON 

reflectron

EINZEL_LENS 

einzel lens

FIRST_STABILITY_REGION 

first stability region

FRINGING_FIELD 

fringing field

KINETIC_ENERGY_ANALYZER 

kinetic energy analyzer

STATIC_FIELD 

static field

SIZE_OF_IONOPTICSTYPE 

Constructor & Destructor Documentation

Instrument (  ) 

Constructor.

Instrument ( const Instrument &  source  ) 

Copy constructor.

~Instrument (  ) 

Destructor.

Member Function Documentation

const String& getCustomizations (  )  const

returns a description of customizations

Referenced by DBAdapter::storeExperiment(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

const std::vector<IonDetector>& getIonDetectors (  )  const

returns a const reference to the ion detector list

Referenced by MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

std::vector<IonDetector>& getIonDetectors (  ) 

returns a mutable reference to the ion detector list

IonOpticsType getIonOptics (  )  const

returns the ion optics type

Referenced by DBAdapter::storeExperiment(), and MzMLHandler< MapType >::writeTo().

const std::vector<IonSource>& getIonSources (  )  const

returns a const reference to the ion source list

Referenced by XMassFile::importExperimentalSettings(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

std::vector<IonSource>& getIonSources (  ) 

returns a mutable reference to the ion source list

std::vector<MassAnalyzer>& getMassAnalyzers (  ) 

returns a mutable reference to the mass analyzer list

const std::vector<MassAnalyzer>& getMassAnalyzers (  )  const

returns a const reference to the mass analyer list

Referenced by XMassFile::importExperimentalSettings(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

const String& getModel (  )  const

returns the instrument model

Referenced by DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

const String& getName (  )  const

returns the name of the instrument

Referenced by MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

const Software& getSoftware (  )  const

returns a const reference to the instrument software

Referenced by DBAdapter::storeExperiment(), and MzXMLHandler< MapType >::writeTo().

Software& getSoftware (  ) 

returns a mutable reference to the instrument software

const String& getVendor (  )  const

returns the instrument vendor

Referenced by DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

bool operator!= ( const Instrument &  rhs  )  const

Equality operator.

Instrument& operator= ( const Instrument &  source  ) 

Assignement operator.

bool operator== ( const Instrument &  rhs  )  const

Equality operator.

void setCustomizations ( const String &  customizations  ) 

sets the a description of customizations

void setIonDetectors ( const std::vector< IonDetector > &  ion_detectors  ) 

sets the ion detector list

void setIonOptics ( IonOpticsType  ion_optics  ) 

sets the ion optics type

void setIonSources ( const std::vector< IonSource > &  ion_sources  ) 

sets the ion source list

void setMassAnalyzers ( const std::vector< MassAnalyzer > &  mass_analyzers  ) 

sets the mass analyzer list

void setModel ( const String &  model  ) 

sets the instrument model

Referenced by XMassFile::importExperimentalSettings().

void setName ( const String &  name  ) 

sets the name of the instrument

Referenced by XMassFile::importExperimentalSettings().

void setSoftware ( const Software &  software  ) 

sets the instrument software

void setVendor ( const String &  vendor  ) 

sets the instrument vendor

Referenced by XMassFile::importExperimentalSettings().

Member Data Documentation

String customizations_ [protected]
std::vector<IonDetector> ion_detectors_ [protected]
IonOpticsType ion_optics_ [protected]
std::vector<IonSource> ion_sources_ [protected]
std::vector<MassAnalyzer> mass_analyzers_ [protected]
String model_ [protected]
String name_ [protected]
const std::string NamesOfIonOpticsType[SIZE_OF_IONOPTICSTYPE] [static]

Names of inlet types.

Software software_ [protected]
String vendor_ [protected]
OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1