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:
 
CVParam cvParamChild (CVID cvid) const
 finds child of cvid in the container:
 
template<typename ValueT >
ValueT cvParamValueOrDefault (CVID cvid, ValueT defaultValue) const
 finds cvid in the container:
 
template<typename ValueT >
ValueT cvParamChildValueOrDefault (CVID cvid, ValueT defaultValue) 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)
 
bool empty () const
 returns true iff the element contains no params or param groups
 
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

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

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(), test(), test_v3(), testParamContainer(), verifyPrecursorInfo(), verifyPrecursorInfo(), 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 EvenMS2Predicate::accept(), FTSieve::accept(), doSomething(), testBasic(), and testParamContainer().

◆ cvParamValueOrDefault()

template<typename ValueT >
ValueT pwiz::data::ParamContainer::cvParamValueOrDefault ( CVID  cvid,
ValueT  defaultValue 
) const
inline

finds cvid in the container:

  • returns first CVParam result's value such that (result.cvid == cvid);
  • if not found, returns the given default value
  • recursive: looks into paramGroupPtrs

Definition at line 272 of file ParamTypes.hpp.

273 {
274 CVParam p = cvParam(cvid);
275 return p.empty() ? defaultValue : p.valueAs<ValueT>();
276 }
T defaultValue()
CVParam cvParam(CVID cvid) const
finds cvid in the container:

References defaultValue(), pwiz::data::CVParam::empty(), and pwiz::data::CVParam::valueAs().

Referenced by testParamContainer().

◆ cvParamChildValueOrDefault()

template<typename ValueT >
ValueT pwiz::data::ParamContainer::cvParamChildValueOrDefault ( CVID  cvid,
ValueT  defaultValue 
) const
inline

finds child of cvid in the container:

  • returns first CVParam result's value such that (result.cvid is_a cvid);
  • if not found, returns the given default value
  • recursive: looks into paramGroupPtrs

Definition at line 283 of file ParamTypes.hpp.

284 {
285 CVParam p = cvParamChild(cvid);
286 return p.empty() ? defaultValue : p.valueAs<ValueT>();
287 }
CVParam cvParamChild(CVID cvid) const
finds child of cvid in the container:

References defaultValue(), pwiz::data::CVParam::empty(), and pwiz::data::CVParam::valueAs().

Referenced by 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

returns true iff cvParams contains exact cvid (recursive)

Referenced by test(), test(), and testParamContainer().

◆ 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 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 317 of file ParamTypes.hpp.

318 {
319 set(cvid, boost::lexical_cast<std::string>(value), units);
320 }
void set(CVID cvid, const std::string &value="", CVID units=CVID_Unknown)
set/add a CVParam (not recursive)

◆ empty()

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

◆ 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 339 of file ParamTypes.hpp.

340{
341 set(cvid, (value ? "true" : "false"), units);
342}

References set().

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: