| OpenMS 2.5.0

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

Parameters specific to a database search step. More...

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

Inheritance diagram for DBSearchParam:

## Public Member Functions

| DBSearchParam ()
| DBSearchParam (const DBSearchParam &other)=default
bool | operator< (const DBSearchParam &other) const
bool | operator== (const DBSearchParam &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

enum MoleculeType | molecule_type
enum MassType | mass_type
String | database
String | database_version
String | taxonomy
std::set< Int > | charges
std::set< String > | fixed_mods
std::set< String > | variable_mods
double | precursor_mass_tolerance
double | fragment_mass_tolerance
bool | precursor_tolerance_ppm
bool | fragment_tolerance_ppm
const DigestionEnzyme * | digestion_enzyme
Size | missed_cleavages
Size | min_length
Size | max_length

## 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

Parameters specific to a database search step.

## Constructor & Destructor Documentation

## ◆ DBSearchParam() [1/2]

DBSearchParam | ( |  | ) |

inline

## ◆ DBSearchParam() [2/2]

DBSearchParam | ( | const DBSearchParam & | other | ) |

default

## Member Function Documentation

## ◆ operator<()

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

inline

References DBSearchParam::charges, DBSearchParam::database, DBSearchParam::database_version, DBSearchParam::digestion_enzyme, DBSearchParam::fixed_mods, DBSearchParam::fragment_mass_tolerance, DBSearchParam::fragment_tolerance_ppm, DBSearchParam::mass_type, DBSearchParam::max_length, DBSearchParam::min_length, DBSearchParam::missed_cleavages, DBSearchParam::molecule_type, DBSearchParam::precursor_mass_tolerance, DBSearchParam::precursor_tolerance_ppm, DBSearchParam::taxonomy, and DBSearchParam::variable_mods.

## ◆ operator==()

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

inline

References DBSearchParam::charges, DBSearchParam::database, DBSearchParam::database_version, DBSearchParam::digestion_enzyme, DBSearchParam::fixed_mods, DBSearchParam::fragment_mass_tolerance, DBSearchParam::fragment_tolerance_ppm, DBSearchParam::mass_type, DBSearchParam::max_length, DBSearchParam::min_length, DBSearchParam::missed_cleavages, DBSearchParam::molecule_type, DBSearchParam::precursor_mass_tolerance, DBSearchParam::precursor_tolerance_ppm, DBSearchParam::taxonomy, and DBSearchParam::variable_mods.

## Member Data Documentation

## ◆ charges

std::set<Int> charges

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ database

String database

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ database_version

String database_version

Referenced by DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ digestion_enzyme

const DigestionEnzyme* digestion_enzyme

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ fixed_mods

std::set<String> fixed_mods

Referenced by DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ fragment_mass_tolerance

double fragment_mass_tolerance

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ fragment_tolerance_ppm

bool fragment_tolerance_ppm

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ mass_type

enum MassType mass_type

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ max_length

Size max_length

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ min_length

Size min_length

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ missed_cleavages

Size missed_cleavages

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ molecule_type

enum MoleculeType molecule_type

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ precursor_mass_tolerance

double precursor_mass_tolerance

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ precursor_tolerance_ppm

bool precursor_tolerance_ppm

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ taxonomy

String taxonomy

Referenced by DBSearchParam::operator<(), and DBSearchParam::operator==().

## ◆ variable_mods

std::set<String> variable_mods

Referenced by NucleicAcidSearchEngine::main_(), DBSearchParam::operator<(), and DBSearchParam::operator==().