OpenMS  2.4.0
Public Member Functions | Public Attributes | List of all members
ProteinIdentification::SearchParameters Struct Reference

Search parameters of the DB search. More...

#include <OpenMS/METADATA/ProteinIdentification.h>

Inheritance diagram for ProteinIdentification::SearchParameters:
MetaInfoInterface

Public Member Functions

 SearchParameters ()
 
bool operator== (const SearchParameters &rhs) const
 
bool operator!= (const SearchParameters &rhs) const
 
- 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 (or DataValue::EMPTY if not found) More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to an index (or 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 db
 The used database. More...
 
String db_version
 The database version. More...
 
String taxonomy
 The taxonomy restriction. More...
 
String charges
 The allowed charges for the search. More...
 
PeakMassType mass_type
 Mass type of the peaks. More...
 
std::vector< Stringfixed_modifications
 Used fixed modifications. More...
 
std::vector< Stringvariable_modifications
 Allowed variable modifications. More...
 
UInt missed_cleavages
 The number of allowed missed cleavages. More...
 
double fragment_mass_tolerance
 Mass tolerance of fragment ions (Dalton or ppm) More...
 
bool fragment_mass_tolerance_ppm
 Mass tolerance unit of fragment ions (true: ppm, false: Dalton) More...
 
double precursor_mass_tolerance
 Mass tolerance of precursor ions (Dalton or ppm) More...
 
bool precursor_mass_tolerance_ppm
 Mass tolerance unit of precursor ions (true: ppm, false: Dalton) More...
 
Protease digestion_enzyme
 The cleavage site information in details (from ProteaseDB) 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...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Detailed Description

Search parameters of the DB search.

Constructor & Destructor Documentation

◆ SearchParameters()

Member Function Documentation

◆ operator!=()

bool operator!= ( const SearchParameters rhs) const

◆ operator==()

bool operator== ( const SearchParameters rhs) const

Member Data Documentation

◆ charges

String charges

◆ db

String db

◆ db_version

String db_version

The database version.

◆ digestion_enzyme

Protease digestion_enzyme

◆ fixed_modifications

std::vector<String> fixed_modifications

◆ fragment_mass_tolerance

double fragment_mass_tolerance

◆ fragment_mass_tolerance_ppm

bool fragment_mass_tolerance_ppm

Mass tolerance unit of fragment ions (true: ppm, false: Dalton)

Referenced by TOPPOpenPepXLLF::main_(), TOPPOpenPepXL::main_(), SimpleSearchEngine::postProcessHits_(), and RNPxlSearch::postProcessHits_().

◆ mass_type

PeakMassType mass_type

◆ missed_cleavages

UInt missed_cleavages

◆ precursor_mass_tolerance

double precursor_mass_tolerance

◆ precursor_mass_tolerance_ppm

bool precursor_mass_tolerance_ppm

Mass tolerance unit of precursor ions (true: ppm, false: Dalton)

Referenced by TOPPOpenPepXLLF::main_(), TOPPOpenPepXL::main_(), SimpleSearchEngine::postProcessHits_(), and RNPxlSearch::postProcessHits_().

◆ taxonomy

String taxonomy

The taxonomy restriction.

◆ variable_modifications

std::vector<String> variable_modifications