IonSource Class Reference

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

#include <OpenMS/METADATA/IonSource.h>

Inheritance diagram for IonSource:

Collaboration diagram for IonSource:

Public Types
enum class	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 class	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 class	Polarity { POLNULL , POSITIVE , NEGATIVE , SIZE_OF_POLARITY }
	Polarity of the ion source. More...

Public Member Functions
	IonSource ()
	Constructor.
	IonSource (const IonSource &)=default
	Copy constructor.
	IonSource (IonSource &&)=default
	Move constructor.
	~IonSource ()
	Destructor.
IonSource &	operator= (const IonSource &)=default
	Assignment operator.
IonSource &	operator= (IonSource &&) &=default
	Move assignment operator.
bool	operator== (const IonSource &rhs) const
	Equality operator.
bool	operator!= (const IonSource &rhs) const
	Equality operator.
InletType	getInletType () const
	returns the inlet type
void	setInletType (InletType inlet_type)
	sets the inlet type
IonizationMethod	getIonizationMethod () const
	returns the ionization method
void	setIonizationMethod (IonizationMethod ionization_type)
	sets the ionization method
Polarity	getPolarity () const
	returns the ionization mode
void	setPolarity (Polarity polarity)
	sets the ionization mode
Int	getOrder () const
	returns the position of this part in the whole Instrument.
void	setOrder (Int order)
	sets the order
Public Member Functions inherited from MetaInfoInterface
	MetaInfoInterface ()=default
	Constructor.
	MetaInfoInterface (const MetaInfoInterface &rhs)
	Copy constructor.
	MetaInfoInterface (MetaInfoInterface &&) noexcept
	Move constructor.
	~MetaInfoInterface ()
	Destructor.
MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator.
MetaInfoInterface &	operator= (MetaInfoInterface &&) noexcept
	Move assignment operator.
void	swap (MetaInfoInterface &rhs)
	Swap contents.
bool	operator== (const MetaInfoInterface &rhs) const
	Equality operator.
bool	operator!= (const MetaInfoInterface &rhs) const
	Equality operator.
const DataValue &	getMetaValue (const String &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.
DataValue	getMetaValue (const String &name, const DataValue &default_value) const
	Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found.
DataValue	getMetaValue (UInt index, const DataValue &default_value) const
	Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
bool	metaValueExists (const String &name) const
	Returns whether an entry with the given name exists.
bool	metaValueExists (UInt index) const
	Returns whether an entry with the given index exists.
void	setMetaValue (const String &name, const DataValue &value)
	Sets the DataValue corresponding to a name.
void	setMetaValue (UInt index, const DataValue &value)
	Sets the DataValue corresponding to an index.
void	removeMetaValue (const String &name)
	Removes the DataValue corresponding to name if it exists.
void	removeMetaValue (UInt index)
	Removes the DataValue corresponding to index if it exists.
void	addMetaValues (const MetaInfoInterface &from)
void	getKeys (std::vector< String > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
void	getKeys (std::vector< UInt > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
bool	isMetaEmpty () const
	Returns if the MetaInfo is empty.
void	clearMetaInfo ()
	Removes all meta values.

Static Public Member Functions
static StringList	getAllNamesOfInletType ()
	Returns all inlet type names known to OpenMS.
static StringList	getAllNamesOfIonizationMethod ()
	Returns all ionization method names known to OpenMS.
static StringList	getAllNamesOfPolarity ()
	Returns all polarity names known to OpenMS.
static const std::string &	inletTypeToString (InletType type)
	Convert an InletType enum to its string representation.
static InletType	toInletType (const std::string &name)
	Convert a string to an InletType enum.
static const std::string &	ionizationMethodToString (IonizationMethod method)
	Convert an IonizationMethod enum to its string representation.
static IonizationMethod	toIonizationMethod (const std::string &name)
	Convert a string to an IonizationMethod enum.
static const std::string &	polarityToString (Polarity polarity)
	Convert a Polarity enum to its string representation.
static Polarity	toPolarity (const std::string &name)
	Convert a string to a Polarity enum.
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	Returns a reference to the MetaInfoRegistry.

Static Public Attributes
static const std::string	NamesOfInletType [static_cast< size_t >(InletType::SIZE_OF_INLETTYPE)]
	Names of inlet types.
static const std::string	NamesOfIonizationMethod [static_cast< size_t >(IonizationMethod::SIZE_OF_IONIZATIONMETHOD)]
	Names of ionization methods.
static const std::string	NamesOfPolarity [static_cast< size_t >(Polarity::SIZE_OF_POLARITY)]
	Names of polarity of the ion source.

Protected Attributes
InletType	inlet_type_
IonizationMethod	ionization_method_
Polarity	polarity_
Int	order_
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

Additional Inherited Members
Protected Member Functions inherited from MetaInfoInterface
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.

Detailed Description

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

Member Enumeration Documentation

InletType

enum class InletType

strong

inlet type

Enumerator
INLETNULL	Unknown.
DIRECT	Direct.
BATCH	Batch (e.g. in MALDI)
CHROMATOGRAPHY	Chromatography (liquid)
PARTICLEBEAM	Particle beam.
MEMBRANESEPARATOR	Membrane separator.
OPENSPLIT	Open split.
JETSEPARATOR	Jet separator.
SEPTUM	Septum.
RESERVOIR	Reservoir.
MOVINGBELT	Moving belt.
MOVINGWIRE	Moving wire.
FLOWINJECTIONANALYSIS	Flow injection analysis.
ELECTROSPRAYINLET	Electro spray.
THERMOSPRAYINLET	Thermo spray.
INFUSION	Infusion.
CONTINUOUSFLOWFASTATOMBOMBARDMENT	Continuous flow fast atom bombardment.
INDUCTIVELYCOUPLEDPLASMA	Inductively coupled plasma.
MEMBRANE	Membrane inlet.
NANOSPRAY	Nanospray inlet.
SIZE_OF_INLETTYPE

IonizationMethod

enum class IonizationMethod

strong

ionization method

Enumerator
IONMETHODNULL	Unknown.
ESI	electrospray ionisation
EI	electron ionization
CI	chemical ionisation
FAB	fast atom bombardment
TSP	thermospray
LD	laser desorption
FD	field desorption
FI	flame ionization
PD	plasma desorption
SI	secondary ion MS
TI	thermal ionization
API	atmospheric pressure ionisation
ISI
CID	collision induced decomposition
CAD	collision activated decomposition
HN
APCI	atmospheric pressure chemical ionization
APPI	atmospheric pressure photo ionization
ICP	inductively coupled plasma
NESI	Nano electrospray ionization.
MESI	Micro electrospray ionization.
SELDI	Surface enhanced laser desorption ionization.
SEND	Surface enhanced neat desorption.
FIB	Fast ion bombardment.
MALDI	Matrix-assisted laser desorption ionization.
MPI	Multiphoton ionization.
DI	desorption ionization
FA	flowing afterglow
FII	field ionization
GD_MS	glow discharge ionization
NICI	negative ion chemical ionization
NRMS	neutralization reionization mass spectrometry
PI	photoionization
PYMS	pyrolysis mass spectrometry
REMPI	resonance enhanced multiphoton ionization
AI	adiabatic ionization
ASI	associative ionization
AD	autodetachment
AUI	autoionization
CEI	charge exchange ionization
CHEMI	chemi-ionization
DISSI	dissociative ionization
LSI	liquid secondary ionization
PEI	penning ionization
SOI	soft ionization
SPI	spark ionization
SUI	surface ionization
VI	vertical ionization
AP_MALDI	atmospheric pressure matrix-assisted laser desorption ionization
SILI	desorption/ionization on silicon
SALDI	surface-assisted laser desorption ionization
SIZE_OF_IONIZATIONMETHOD

Polarity

enum class Polarity

strong

Polarity of the ion source.

Enumerator
POLNULL	Unknown.
POSITIVE	Positive polarity.
NEGATIVE	Negative polarity.
SIZE_OF_POLARITY

Constructor & Destructor Documentation

IonSource() [1/3]

IonSource

(

)

Constructor.

IonSource() [2/3]

IonSource ( const IonSource &  )

default

Copy constructor.

IonSource() [3/3]

IonSource ( IonSource &&  )

default

Move constructor.

~IonSource()

~IonSource

(

)

Destructor.

Member Function Documentation

getAllNamesOfInletType()

static StringList getAllNamesOfInletType ( )

static

Returns all inlet type names known to OpenMS.

Note

For performance-critical code that repeatedly accesses these names, cache the returned list to avoid repeated allocations.

getAllNamesOfIonizationMethod()

static StringList getAllNamesOfIonizationMethod ( )

static

Returns all ionization method names known to OpenMS.

Note

For performance-critical code that repeatedly accesses these names, cache the returned list to avoid repeated allocations.

getAllNamesOfPolarity()

static StringList getAllNamesOfPolarity ( )

static

Returns all polarity names known to OpenMS.

Note

For performance-critical code that repeatedly accesses these names, cache the returned list to avoid repeated allocations.

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

inletTypeToString()

static const std::string & inletTypeToString ( InletType  type )

static

Convert an InletType enum to its string representation.

Parameters

type	The inlet type enum value to convert

Returns

Reference to the string representation

Exceptions

Exception::InvalidValue

if type is SIZE_OF_INLETTYPE

ionizationMethodToString()

static const std::string & ionizationMethodToString ( IonizationMethod  method )

static

Convert an IonizationMethod enum to its string representation.

Parameters

method

The ionization method enum value to convert

Returns

Reference to the string representation

Exceptions

Exception::InvalidValue

if method is SIZE_OF_IONIZATIONMETHOD

operator!=()

bool operator!=

(

const IonSource &

rhs

)

const

Equality operator.

operator=() [1/2]

IonSource & operator= ( const IonSource &  )

default

Assignment operator.

operator=() [2/2]

IonSource & operator= ( IonSource &&  ) &

default

Move assignment operator.

operator==()

bool operator==

(

const IonSource &

rhs

)

const

Equality operator.

polarityToString()

static const std::string & polarityToString ( Polarity  polarity )

static

Convert a Polarity enum to its string representation.

Parameters

polarity

The polarity enum value to convert

Returns

Reference to the string representation

Exceptions

Exception::InvalidValue

if polarity is SIZE_OF_POLARITY

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

toInletType()

static InletType toInletType ( const std::string &  name )

static

Convert a string to an InletType enum.

Parameters

name	The string name to convert

Returns

The corresponding InletType enum value

Exceptions

Exception::InvalidValue

if name is not found in NamesOfInletType[]

toIonizationMethod()

static IonizationMethod toIonizationMethod ( const std::string &  name )

static

Convert a string to an IonizationMethod enum.

Parameters

name	The string name to convert

Returns

The corresponding IonizationMethod enum value

Exceptions

Exception::InvalidValue

if name is not found in NamesOfIonizationMethod[]

toPolarity()

static Polarity toPolarity ( const std::string &  name )

static

Convert a string to a Polarity enum.

Parameters

name	The string name to convert

Returns

The corresponding Polarity enum value

Exceptions

Exception::InvalidValue

if name is not found in NamesOfPolarity[]

Member Data Documentation

inlet_type_

InletType inlet_type_

protected

ionization_method_

IonizationMethod ionization_method_

protected

NamesOfInletType

const std::string NamesOfInletType[static_cast< size_t >(InletType::SIZE_OF_INLETTYPE)]

static

Names of inlet types.

NamesOfIonizationMethod

const std::string NamesOfIonizationMethod[static_cast< size_t >(IonizationMethod::SIZE_OF_IONIZATIONMETHOD)]

static

Names of ionization methods.

NamesOfPolarity

const std::string NamesOfPolarity[static_cast< size_t >(Polarity::SIZE_OF_POLARITY)]

static

Names of polarity of the ion source.

order_

Int order_

protected

polarity_

Polarity polarity_

protected