ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::data::ParamContainer Struct Reference

The base class for elements that may contain cvParams, userParams, or paramGroup references. More...

#include <ParamTypes.hpp>

Inheritance diagram for pwiz::data::ParamContainer:
pwiz::data::ParamGroup pwiz::identdata::AmbiguousResidue pwiz::identdata::IdentifiableParamContainer pwiz::identdata::Modification pwiz::identdata::SearchModification pwiz::msdata::Activation pwiz::msdata::BinaryDataArray pwiz::msdata::Chromatogram pwiz::msdata::Component pwiz::msdata::Contact pwiz::msdata::FileContent pwiz::msdata::InstrumentConfiguration pwiz::msdata::IsolationWindow pwiz::msdata::Precursor pwiz::msdata::ProcessingMethod pwiz::msdata::Run pwiz::msdata::Sample pwiz::msdata::Scan pwiz::msdata::ScanList pwiz::msdata::ScanWindow pwiz::msdata::SelectedIon pwiz::msdata::Software pwiz::msdata::SourceFile pwiz::msdata::Spectrum pwiz::msdata::Target pwiz::tradata::Compound pwiz::tradata::Configuration pwiz::tradata::Contact pwiz::tradata::Evidence pwiz::tradata::Instrument pwiz::tradata::Interpretation pwiz::tradata::Modification pwiz::tradata::Peptide pwiz::tradata::Precursor pwiz::tradata::Prediction pwiz::tradata::Product pwiz::tradata::Protein pwiz::tradata::Publication pwiz::tradata::RetentionTime pwiz::tradata::Software pwiz::tradata::Target pwiz::tradata::TargetList pwiz::tradata::Transition pwiz::tradata::Validation

Public Member Functions

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

Public Attributes

std::vector< ParamGroupPtrparamGroupPtrs
 a collection of references to ParamGroups More...
 
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms More...
 
std::vector< UserParamuserParams
 a collection of uncontrolled user terms More...
 

Detailed Description

The base class for elements that may contain cvParams, userParams, or paramGroup references.

Definition at line 244 of file ParamTypes.hpp.

Member Function Documentation

§ cvParam()

CVParam pwiz::data::ParamContainer::cvParam ( CVID  cvid) const

finds cvid in the container:

  • returns first CVParam result such that (result.cvid == cvid);
  • if not found, returns CVParam(CVID_Unknown)
  • recursive: looks into paramGroupPtrs

Referenced by EvenMS2Predicate::accept(), checkSpectrumInfo(), MSLevelSorter::less(), test(), testAmbiguousResidue(), testParamContainer(), testPrecursor(), verifyPrecursorMZ(), and verifyScanInfo().

§ cvParamChild()

CVParam pwiz::data::ParamContainer::cvParamChild ( CVID  cvid) const

finds child of cvid in the container:

  • returns first CVParam result such that (result.cvid is_a cvid);
  • if not found, CVParam(CVID_Unknown)
  • recursive: looks into paramGroupPtrs

Referenced by FTSieve::accept(), EvenMS2Predicate::accept(), doSomething(), and testParamContainer().

§ cvParamChildren()

std::vector<CVParam> pwiz::data::ParamContainer::cvParamChildren ( CVID  cvid) const

finds all children of cvid in the container:

  • returns all CVParam results such that (result.cvid is_a cvid);
  • if not found, empty vector
  • recursive: looks into paramGroupPtrs

Referenced by testParamContainer().

§ hasCVParam()

bool pwiz::data::ParamContainer::hasCVParam ( CVID  cvid) const

§ hasCVParamChild()

bool pwiz::data::ParamContainer::hasCVParamChild ( CVID  cvid) const

returns true iff cvParams contains a child (is_a) of cvid (recursive)

Referenced by testParamContainer().

§ userParam()

UserParam pwiz::data::ParamContainer::userParam ( const std::string &  ) const

finds UserParam with specified name

  • returns UserParam() if name not found
  • not recursive: looks only at local userParams

Referenced by testMaxPrecisionDiff(), and testParamContainer().

§ set() [1/5]

void pwiz::data::ParamContainer::set ( CVID  cvid,
const std::string &  value = "",
CVID  units = CVID_Unknown 
)

§ set() [2/5]

void pwiz::data::ParamContainer::set ( CVID  cvid,
double  value,
CVID  units = CVID_Unknown 
)

set/add a CVParam (not recursive)

§ set() [3/5]

void pwiz::data::ParamContainer::set ( CVID  cvid,
int  value,
CVID  units = CVID_Unknown 
)

set/add a CVParam (not recursive)

§ set() [4/5]

template<typename value_type >
void pwiz::data::ParamContainer::set ( CVID  cvid,
value_type  value,
CVID  units = CVID_Unknown 
)
inline

set/add a CVParam (not recursive)

Definition at line 295 of file ParamTypes.hpp.

References boost::lexical_cast(), pwiz::frequency::operator!=(), pwiz::data::operator==(), and pwiz::msdata::id::value().

296  {
297  set(cvid, boost::lexical_cast<std::string>(value), units);
298  }
float lexical_cast(const std::string &str)
PWIZ_API_DECL std::string value(const std::string &id, const std::string &name)
convenience function to extract a named value from an id string

§ empty()

bool pwiz::data::ParamContainer::empty ( ) const

returns true iff the element contains no params or param groups

Referenced by pwiz::identdata::TextWriter::operator()(), and pwiz::msdata::TextWriter::operator()().

§ clear()

void pwiz::data::ParamContainer::clear ( )

clears the collections

Referenced by stripUnmappedMetadata(), testFilter(), and testPepXMLSpecificity().

§ operator==()

bool pwiz::data::ParamContainer::operator== ( const ParamContainer that) const

returns true iff this and that have the exact same cvParams and userParams

  • recursive: looks into paramGroupPtrs

§ operator!=()

bool pwiz::data::ParamContainer::operator!= ( const ParamContainer that) const

returns !(this==that)

§ set() [5/5]

template<>
void pwiz::data::ParamContainer::set ( CVID  cvid,
bool  value,
CVID  units 
)
inline

special case for bool (outside the class for gcc 3.4, and inline for msvc)

Definition at line 317 of file ParamTypes.hpp.

318 {
319  set(cvid, (value ? "true" : "false"), units);
320 }
PWIZ_API_DECL std::string value(const std::string &id, const std::string &name)
convenience function to extract a named value from an id string

Member Data Documentation

§ paramGroupPtrs

std::vector<ParamGroupPtr> pwiz::data::ParamContainer::paramGroupPtrs

§ cvParams

std::vector<CVParam> pwiz::data::ParamContainer::cvParams

§ userParams

std::vector<UserParam> pwiz::data::ParamContainer::userParams

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