Description of an ion source (part of a MS Instrument) More...
#include <OpenMS/METADATA/IonSource.h>
Inheritance diagram for IonSource:
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... | |
| IonSource & | operator= (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... | |
| MetaInfoInterface & | operator= (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 DataValue & | getMetaValue (const String &name) const |
| Returns the value corresponding to a string (or DataValue::EMPTY if not found) More... | |
| const DataValue & | getMetaValue (UInt index) const |
| Returns the value corresponding to an index (or DataValue::EMPTY if not found) More... | |
| bool | metaValueExists (const String &name) const |
| Returns whether an entry with the given name exists. More... | |
| bool | metaValueExists (UInt index) const |
| Returns whether an entry with the given index exists. 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 | |
| MetaInfo * | meta_ |
| Pointer to the MetaInfo object (0 by default) More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MetaInfoInterface | |
| static MetaInfoRegistry & | metaRegistry () |
| 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)
Member Enumeration Documentation
◆ InletType
| enum InletType |
inlet type
◆ IonizationMethod
| enum IonizationMethod |
ionization method
◆ Polarity
| enum Polarity |
Constructor & Destructor Documentation
◆ IonSource() [1/2]
| IonSource | ( | ) |
Constructor.
◆ IonSource() [2/2]
◆ ~IonSource()
| ~IonSource | ( | ) |
Destructor.
Member Function Documentation
◆ getInletType()
| InletType getInletType | ( | ) | const |
returns the inlet type
◆ getIonizationMethod()
| IonizationMethod getIonizationMethod | ( | ) | const |
returns the ionization method
◆ getOrder()
| 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.
◆ getPolarity()
| Polarity getPolarity | ( | ) | const |
returns the ionization mode
◆ operator!=()
| bool operator!= | ( | const IonSource & | rhs | ) | const |
Equality operator.
◆ operator=()
◆ operator==()
| bool operator== | ( | const IonSource & | rhs | ) | const |
Equality operator.
◆ setInletType()
| void setInletType | ( | InletType | inlet_type | ) |
sets the inlet type
◆ setIonizationMethod()
| void setIonizationMethod | ( | IonizationMethod | ionization_type | ) |
sets the ionization method
◆ setOrder()
| void setOrder | ( | Int | order | ) |
sets the order
◆ setPolarity()
| void setPolarity | ( | Polarity | polarity | ) |
sets the ionization mode
Member Data Documentation
◆ inlet_type_
|
protected |
◆ ionization_method_
|
protected |
◆ NamesOfInletType
|
static |
Names of inlet types.
◆ NamesOfIonizationMethod
|
static |
Names of ionization methods.
◆ NamesOfPolarity
|
static |
Names of polarity of the ion source.
◆ order_
|
protected |
◆ polarity_
|
protected |