Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
IonSource Class Reference

Description of an ion source (part of a MS Instrument) More...

#include <OpenMS/METADATA/IonSource.h>

Inheritance diagram for IonSource:
MetaInfoInterface

Public Types

enum  InletType {
  INLETNULL, DIRECT, BATCH, CHROMATOGRAPHY,
  PARTICLEBEAM, MEMBRANESEPARATOR, OPENSPLIT, JETSEPARATOR,
  SEPTUM, RESERVOIR, MOVINGBELT, MOVINGWIRE,
  FLOWINJECTIONANALYSIS, ELECTROSPRAYINLET, THERMOSPRAYINLET, INFUSION,
  CONTINUOUSFLOWFASTATOMBOMBARDMENT, INDUCTIVELYCOUPLEDPLASMA, MEMBRANE, NANOSPRAY,
  SIZE_OF_INLETTYPE
}
 inlet type More...
 
enum  IonizationMethod {
  IONMETHODNULL, ESI, EI, CI,
  FAB, TSP, LD, FD,
  FI, PD, SI, TI,
  API, ISI, CID, CAD,
  HN, APCI, APPI, ICP,
  NESI, MESI, SELDI, SEND,
  FIB, MALDI, MPI, DI,
  FA, FII, GD_MS, NICI,
  NRMS, PI, PYMS, REMPI,
  AI, ASI, AD, AUI,
  CEI, CHEMI, DISSI, LSI,
  PEI, SOI, SPI, SUI,
  VI, AP_MALDI, SILI, SALDI,
  SIZE_OF_IONIZATIONMETHOD
}
 ionization method More...
 
enum  Polarity { POLNULL, POSITIVE, NEGATIVE, SIZE_OF_POLARITY }
 Polarity of the ion source. More...
 

Public Member Functions

 IonSource ()
 Constructor. More...
 
 IonSource (const IonSource &source)
 Copy constructor. More...
 
 ~IonSource ()
 Destructor. More...
 
IonSourceoperator= (const IonSource &source)
 Assignment operator. More...
 
bool operator== (const IonSource &rhs) const
 Equality operator. More...
 
bool operator!= (const IonSource &rhs) const
 Equality operator. More...
 
InletType getInletType () const
 returns the inlet type More...
 
void setInletType (InletType inlet_type)
 sets the inlet type More...
 
IonizationMethod getIonizationMethod () const
 returns the ionization method More...
 
void setIonizationMethod (IonizationMethod ionization_type)
 sets the ionization method More...
 
Polarity getPolarity () const
 returns the ionization mode More...
 
void setPolarity (Polarity polarity)
 sets the ionization mode More...
 
Int getOrder () const
 returns the position of this part in the whole Instrument. More...
 
void setOrder (Int order)
 sets the order More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 assignment operator More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 returns the value corresponding to a string More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set More...
 
void setMetaValue (const String &name, const DataValue &value)
 sets the DataValue corresponding to a name More...
 
void setMetaValue (UInt index, const DataValue &value)
 sets the DataValue corresponding to an index More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void getKeys (std::vector< String > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
void getKeys (std::vector< UInt > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
bool isMetaEmpty () const
 returns if the MetaInfo is empty More...
 
void clearMetaInfo ()
 removes all meta values More...
 

Static Public Attributes

static const std::string NamesOfInletType [SIZE_OF_INLETTYPE]
 Names of inlet types. More...
 
static const std::string NamesOfIonizationMethod [SIZE_OF_IONIZATIONMETHOD]
 Names of ionization methods. More...
 
static const std::string NamesOfPolarity [SIZE_OF_POLARITY]
 Names of polarity of the ion source. More...
 

Protected Attributes

InletType inlet_type_
 
IonizationMethod ionization_method_
 
Polarity polarity_
 
Int order_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 returns a reference to the MetaInfoRegistry More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 creates the MetaInfo object if it does not exist More...
 

Detailed Description

Description of an ion source (part of a MS Instrument)

Constructor & Destructor Documentation

IonSource ( )

Constructor.

IonSource ( const IonSource source)

Copy constructor.

~IonSource ( )

Destructor.

Member Function Documentation

InletType getInletType ( ) const

returns the inlet type

Referenced by MzMLHandler< MapType >::writeHeader_().

IonizationMethod getIonizationMethod ( ) const

returns the ionization method

Referenced by MzMLHandler< MapType >::writeHeader_().

Int getOrder ( ) const

returns the position of this part in the whole Instrument.

Order can be ignored, as long the instrument has this default setup:

  • one ion source
  • one or many mass analyzers
  • one ion detector

For more complex instruments, the order should be defined.

Referenced by MzMLHandler< MapType >::writeHeader_().

Polarity getPolarity ( ) const

returns the ionization mode

bool operator!= ( const IonSource rhs) const

Equality operator.

IonSource& operator= ( const IonSource source)

Assignment operator.

bool operator== ( const IonSource rhs) const

Equality operator.

void setInletType ( InletType  inlet_type)

sets the inlet type

void setIonizationMethod ( IonizationMethod  ionization_type)

sets the ionization method

void setOrder ( Int  order)

sets the order

void setPolarity ( Polarity  polarity)

sets the ionization mode

Member Data Documentation

InletType inlet_type_
protected
IonizationMethod ionization_method_
protected
const std::string NamesOfInletType[SIZE_OF_INLETTYPE]
static

Names of inlet types.

const std::string NamesOfIonizationMethod[SIZE_OF_IONIZATIONMETHOD]
static

Names of ionization methods.

const std::string NamesOfPolarity[SIZE_OF_POLARITY]
static

Names of polarity of the ion source.

Int order_
protected
Polarity polarity_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:39 using doxygen 1.8.9.1