OpenMS  2.8.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:
[legend]
Collaboration diagram for DBSearchParam:
[legend]

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...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. 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 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 DataValuegetMetaValue (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 addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one 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< Intcharges
 
std::set< Stringfixed_mods
 
std::set< Stringvariable_mods
 
double precursor_mass_tolerance
 
double fragment_mass_tolerance
 
bool precursor_tolerance_ppm
 
bool fragment_tolerance_ppm
 
const DigestionEnzymedigestion_enzyme
 
EnzymaticDigestion::Specificity enzyme_term_specificity
 
Size missed_cleavages
 
Size min_length
 
Size max_length
 

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...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 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

◆ operator==()

bool operator== ( const DBSearchParam other) const
inline

Member Data Documentation

◆ charges

std::set<Int> charges

◆ database

String database

◆ database_version

String database_version

◆ digestion_enzyme

const DigestionEnzyme* digestion_enzyme

◆ enzyme_term_specificity

EnzymaticDigestion::Specificity enzyme_term_specificity

◆ fixed_mods

std::set<String> fixed_mods

◆ fragment_mass_tolerance

double fragment_mass_tolerance

◆ fragment_tolerance_ppm

bool fragment_tolerance_ppm

◆ mass_type

enum MassType mass_type

◆ max_length

Size max_length

◆ min_length

Size min_length

◆ missed_cleavages

Size missed_cleavages

◆ molecule_type

enum MoleculeType molecule_type

◆ precursor_mass_tolerance

double precursor_mass_tolerance

◆ precursor_tolerance_ppm

bool precursor_tolerance_ppm

◆ taxonomy

String taxonomy

◆ variable_mods

std::set<String> variable_mods