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

Description of a ion detector (part of a MS Instrument) More...

#include <OpenMS/METADATA/IonDetector.h>

Inheritance diagram for IonDetector:
MetaInfoInterface

Public Types

enum  Type {
  TYPENULL, ELECTRONMULTIPLIER, PHOTOMULTIPLIER, FOCALPLANEARRAY,
  FARADAYCUP, CONVERSIONDYNODEELECTRONMULTIPLIER, CONVERSIONDYNODEPHOTOMULTIPLIER, MULTICOLLECTOR,
  CHANNELELECTRONMULTIPLIER, CHANNELTRON, DALYDETECTOR, MICROCHANNELPLATEDETECTOR,
  ARRAYDETECTOR, CONVERSIONDYNODE, DYNODE, FOCALPLANECOLLECTOR,
  IONTOPHOTONDETECTOR, POINTCOLLECTOR, POSTACCELERATIONDETECTOR, PHOTODIODEARRAYDETECTOR,
  INDUCTIVEDETECTOR, ELECTRONMULTIPLIERTUBE, SIZE_OF_TYPE
}
 Detector type. More...
 
enum  AcquisitionMode {
  ACQMODENULL, PULSECOUNTING, ADC, TDC,
  TRANSIENTRECORDER, SIZE_OF_ACQUISITIONMODE
}
 Acquisition mode. More...
 

Public Member Functions

 IonDetector ()
 Constructor. More...
 
 IonDetector (const IonDetector &source)
 Copy constructor. More...
 
 ~IonDetector ()
 Destructor. More...
 
IonDetectoroperator= (const IonDetector &source)
 Assignment operator. More...
 
bool operator== (const IonDetector &rhs) const
 Equality operator. More...
 
bool operator!= (const IonDetector &rhs) const
 Equality operator. More...
 
Type getType () const
 returns the detector type More...
 
void setType (Type type)
 sets the detector type More...
 
AcquisitionMode getAcquisitionMode () const
 returns the acquisition mode More...
 
void setAcquisitionMode (AcquisitionMode acquisition_mode)
 sets the acquisition mode More...
 
double getResolution () const
 returns the resolution (in ns) More...
 
void setResolution (double resolution)
 sets the resolution (in ns) More...
 
double getADCSamplingFrequency () const
 returns the analog-to-digital converter sampling frequency (in Hz) More...
 
void setADCSamplingFrequency (double ADC_sampling_frequency)
 sets the analog-to-digital converter sampling frequency (in Hz) 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 NamesOfType [SIZE_OF_TYPE]
 Names of detector types. More...
 
static const std::string NamesOfAcquisitionMode [SIZE_OF_ACQUISITIONMODE]
 Names of acquisition modes. More...
 

Protected Attributes

Type type_
 
AcquisitionMode acquisition_mode_
 
double resolution_
 
double ADC_sampling_frequency_
 
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 a ion detector (part of a MS Instrument)

Constructor & Destructor Documentation

Constructor.

IonDetector ( const IonDetector source)

Copy constructor.

Destructor.

Member Function Documentation

AcquisitionMode getAcquisitionMode ( ) const

returns the acquisition mode

double getADCSamplingFrequency ( ) const

returns the analog-to-digital converter sampling frequency (in Hz)

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.

double getResolution ( ) const

returns the resolution (in ns)

Type getType ( ) const

returns the detector type

bool operator!= ( const IonDetector rhs) const

Equality operator.

IonDetector& operator= ( const IonDetector source)

Assignment operator.

bool operator== ( const IonDetector rhs) const

Equality operator.

void setAcquisitionMode ( AcquisitionMode  acquisition_mode)

sets the acquisition mode

void setADCSamplingFrequency ( double  ADC_sampling_frequency)

sets the analog-to-digital converter sampling frequency (in Hz)

void setOrder ( Int  order)

sets the order

void setResolution ( double  resolution)

sets the resolution (in ns)

void setType ( Type  type)

sets the detector type

Member Data Documentation

AcquisitionMode acquisition_mode_
protected
double ADC_sampling_frequency_
protected
const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE]
static

Names of acquisition modes.

const std::string NamesOfType[SIZE_OF_TYPE]
static

Names of detector types.

Int order_
protected
double resolution_
protected
Type type_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:53 using doxygen 1.8.9.1