OpenMS
2.5.0
|
Description of a ion detector (part of a MS Instrument) More...
#include <OpenMS/METADATA/IonDetector.h>
Public Member Functions | |
IonDetector () | |
Constructor. More... | |
IonDetector (const IonDetector &)=default | |
Copy constructor. More... | |
IonDetector (IonDetector &&)=default | |
Move constructor. More... | |
~IonDetector () | |
Destructor. More... | |
IonDetector & | operator= (const IonDetector &)=default |
Assignment operator. More... | |
IonDetector & | operator= (IonDetector &&) &=default |
Move 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 (MetaInfoInterface &&) noexcept | |
Move constructor. More... | |
~MetaInfoInterface () | |
Destructor. More... | |
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) |
Assignment operator. More... | |
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept |
Move 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 DataValue &default_value=DataValue::EMPTY) const |
Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More... | |
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const |
Returns the value corresponding to an index, or a default value (default: 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 | 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 | |
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... | |
Description of a ion detector (part of a MS Instrument)
enum AcquisitionMode |
Acquisition mode.
Enumerator | |
---|---|
ACQMODENULL | Unknown. |
PULSECOUNTING | Pulse counting. |
ADC | Analog-digital converter. |
TDC | Time-digital converter. |
TRANSIENTRECORDER | Transient recorder. |
SIZE_OF_ACQUISITIONMODE |
enum Type |
Detector type.
IonDetector | ( | ) |
Constructor.
|
default |
Copy constructor.
|
default |
Move constructor.
~IonDetector | ( | ) |
Destructor.
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:
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.
|
default |
Assignment operator.
|
default |
Move 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
|
protected |
|
protected |
|
static |
Names of acquisition modes.
|
static |
Names of detector types.
|
protected |
|
protected |
|
protected |