| OpenMS 2.5.0

Public Member Functions | Public Attributes | List of all members
DataQuery Struct Reference

Search query, e.g. spectrum or feature. More...

`#include <OpenMS/METADATA/ID/DataQuery.h>`

Inheritance diagram for DataQuery:

## Public Member Functions

| DataQuery (const String &data_id, boost::optional< InputFileRef > input_file_opt=boost::none, double rt=std::numeric_limits< double >::quiet_NaN(), double mz=std::numeric_limits< double >::quiet_NaN())
| DataQuery (const DataQuery &other)=default
bool | operator< (const DataQuery &other) const
bool | operator== (const DataQuery &other) const
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...

## Public Attributes

String | data_id
| spectrum or feature ID (from the file referenced by "input_file_ref"): More...
boost::optional< InputFileRef > | input_file_opt
double | rt
double | mz

## 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...
Protected Attributes inherited from MetaInfoInterface
MetaInfo * | meta_
| Pointer to the MetaInfo object (0 by default) More...

## Detailed Description

Search query, e.g. spectrum or feature.

## Constructor & Destructor Documentation

## ◆ DataQuery() [1/2]

DataQuery | ( | const String & | data_id,
|  | boost::optional< InputFileRef > | input_file_opt = `boost::none`,
|  | double | rt = `std::numeric_limits<double>::quiet_NaN()`,
|  | double | mz = `std::numeric_limits<double>::quiet_NaN()`
| ) |  |

inline explicit

## ◆ DataQuery() [2/2]

DataQuery | ( | const DataQuery & | other | ) |

default

## Member Function Documentation

## ◆ operator<()

bool operator< | ( | const DataQuery & | other | ) | const

inline

References DataQuery::data_id, and DataQuery::input_file_opt.

## ◆ operator==()

bool operator== | ( | const DataQuery & | other | ) | const

inline

References DataQuery::data_id, and DataQuery::input_file_opt.

## Member Data Documentation

## ◆ data_id

String data_id

spectrum or feature ID (from the file referenced by "input_file_ref"):

Referenced by IdentificationDataConverter::exportQueryMatchToMzTab_(), DataQuery::operator<(), and DataQuery::operator==().

## ◆ input_file_opt

boost::optional<InputFileRef> input_file_opt

Referenced by IdentificationDataConverter::exportQueryMatchToMzTab_(), DataQuery::operator<(), and DataQuery::operator==().

## ◆ mz

double mz

Referenced by IdentificationDataConverter::exportQueryMatchToMzTab_().

## ◆ rt

double rt

Referenced by IdentificationDataConverter::exportQueryMatchToMzTab_().