ProteoWizard
Public Member Functions | Public Attributes
pwiz::identdata::SearchModification Struct Reference

Implementation of SearchModificationType from the mzIdentML schema. More...

#include <IdentData.hpp>

Inheritance diagram for pwiz::identdata::SearchModification:
pwiz::data::ParamContainer

List of all members.

Public Member Functions

 SearchModification ()
bool empty () const
 returns true iff the element contains no params or param groups
- Public Member Functions inherited from pwiz::data::ParamContainer
CVParam cvParam (CVID cvid) const
 finds cvid in the container:
CVParam cvParamChild (CVID cvid) const
 finds child of cvid in the container:
std::vector< CVParamcvParamChildren (CVID cvid) const
 finds all children of cvid in the container:
bool hasCVParam (CVID cvid) const
 returns true iff cvParams contains exact cvid (recursive)
bool hasCVParamChild (CVID cvid) const
 returns true iff cvParams contains a child (is_a) of cvid (recursive)
UserParam userParam (const std::string &) const
 finds UserParam with specified name
void set (CVID cvid, const std::string &value="", CVID units=CVID_Unknown)
 set/add a CVParam (not recursive)
void set (CVID cvid, double value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive)
void set (CVID cvid, int value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive)
template<typename value_type >
void set (CVID cvid, value_type value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive)
void clear ()
 clears the collections
bool operator== (const ParamContainer &that) const
 returns true iff this and that have the exact same cvParams and userParams
bool operator!= (const ParamContainer &that) const
 returns !(this==that)
template<>
void set (CVID cvid, bool value, CVID units)
 special case for bool (outside the class for gcc 3.4, and inline for msvc)

Public Attributes

bool fixedMod
double massDelta
std::vector< char > residues
CVParam specificityRules
- Public Attributes inherited from pwiz::data::ParamContainer
std::vector< ParamGroupPtrparamGroupPtrs
 a collection of references to ParamGroups
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms
std::vector< UserParamuserParams
 a collection of uncontrolled user terms

Detailed Description

Implementation of SearchModificationType from the mzIdentML schema.

Filters applied to the search database. The filter must include at least one of Include and Exclude. If both are used, it is assumed that inclusion is performed first.

Definition at line 388 of file IdentData.hpp.


Constructor & Destructor Documentation

pwiz::identdata::SearchModification::SearchModification ( )

Member Function Documentation

bool pwiz::identdata::SearchModification::empty ( ) const

returns true iff the element contains no params or param groups

Reimplemented from pwiz::data::ParamContainer.


Member Data Documentation

bool pwiz::identdata::SearchModification::fixedMod
double pwiz::identdata::SearchModification::massDelta
std::vector<char> pwiz::identdata::SearchModification::residues
CVParam pwiz::identdata::SearchModification::specificityRules

The documentation for this struct was generated from the following file: