ProteoWizard
|
The base class for elements that may contain cvParams, userParams, or paramGroup references. More...
#include <ParamTypes.hpp>
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< CVParam > | cvParamChildren (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< ParamGroupPtr > | paramGroupPtrs |
a collection of references to ParamGroups | |
std::vector< CVParam > | cvParams |
a collection of controlled vocabulary terms | |
std::vector< UserParam > | userParams |
a collection of uncontrolled user terms | |
The base class for elements that may contain cvParams, userParams, or paramGroup references.
Definition at line 244 of file ParamTypes.hpp.
CVParam pwiz::data::ParamContainer::cvParam | ( | CVID | cvid | ) | const |
finds cvid in the container:
Referenced by EvenMS2Predicate::accept(), checkSpectrumInfo(), MSLevelSorter::less(), test(), test(), test_v3(), testParamContainer(), verifyPrecursorInfo(), verifyPrecursorInfo(), verifyPrecursorMZ(), and verifyScanInfo().
CVParam pwiz::data::ParamContainer::cvParamChild | ( | CVID | cvid | ) | const |
finds child of cvid in the container:
Referenced by EvenMS2Predicate::accept(), FTSieve::accept(), doSomething(), testBasic(), and testParamContainer().
|
inline |
finds cvid in the container:
Definition at line 272 of file ParamTypes.hpp.
References defaultValue(), pwiz::data::CVParam::empty(), and pwiz::data::CVParam::valueAs().
Referenced by testParamContainer().
|
inline |
finds child of cvid in the container:
Definition at line 283 of file ParamTypes.hpp.
References defaultValue(), pwiz::data::CVParam::empty(), and pwiz::data::CVParam::valueAs().
Referenced by testParamContainer().
std::vector< CVParam > pwiz::data::ParamContainer::cvParamChildren | ( | CVID | cvid | ) | const |
finds all children of cvid in the container:
Referenced by testParamContainer().
bool pwiz::data::ParamContainer::hasCVParam | ( | CVID | cvid | ) | const |
returns true iff cvParams contains exact cvid (recursive)
Referenced by test(), test(), and testParamContainer().
bool pwiz::data::ParamContainer::hasCVParamChild | ( | CVID | cvid | ) | const |
returns true iff cvParams contains a child (is_a) of cvid (recursive)
Referenced by testParamContainer().
UserParam pwiz::data::ParamContainer::userParam | ( | const std::string & | ) | const |
finds UserParam with specified name
Referenced by testParamContainer().
void pwiz::data::ParamContainer::set | ( | CVID | cvid, |
const std::string & | value = "" , |
||
CVID | units = CVID_Unknown |
||
) |
set/add a CVParam (not recursive)
Referenced by DemuxHelpersTest::initializeLarge(), initializeTestData(), initializeTinyMGF(), initializeTinyMS1(), initializeTinyMS2(), set(), testAmbiguousResidue(), testAnalysisSoftware(), testCleavageAgent(), testContact(), testConversion(), testDBSequence(), testEnzyme(), testEvidence(), testFilter(), testIdentifiableParamContainer(), testInstrumentConfiguration(), testMeasure(), testModification(), testOrganization(), testParamContainer(), testPeptide(), testPeptideEvidence(), testPepXMLSpecificity(), testPerson(), testPrecursor(), testProduct(), testProteinAmbiguityGroup(), testProteinDetectionHypothesis(), testProteinDetectionList(), testProteinDetectionProtocol(), testRetentionTime(), testSample(), testScanList(), testScanSettings(), testSearchDatabase(), testSearchModification(), testSoftware(), testSourceFile(), testSpectrum(), testSpectrumIdentificationItem(), testSpectrumIdentificationProtocol(), testSpectrumIdentificationResult(), testTarget(), testTraData(), testTransition(), and testValidation().
void pwiz::data::ParamContainer::set | ( | CVID | cvid, |
double | value, | ||
CVID | units = CVID_Unknown |
||
) |
set/add a CVParam (not recursive)
void pwiz::data::ParamContainer::set | ( | CVID | cvid, |
int | value, | ||
CVID | units = CVID_Unknown |
||
) |
set/add a CVParam (not recursive)
|
inline |
set/add a CVParam (not recursive)
Definition at line 317 of file ParamTypes.hpp.
bool pwiz::data::ParamContainer::empty | ( | ) | const |
returns true iff the element contains no params or param groups
Referenced by pwiz::identdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), and verifyPrecursorInfo().
void pwiz::data::ParamContainer::clear | ( | ) |
clears the collections
Referenced by stripUnmappedMetadata(), testFilter(), and testPepXMLSpecificity().
bool pwiz::data::ParamContainer::operator== | ( | const ParamContainer & | that | ) | const |
returns true iff this and that have the exact same cvParams and userParams
bool pwiz::data::ParamContainer::operator!= | ( | const ParamContainer & | that | ) | const |
returns !(this==that)
|
inline |
special case for bool (outside the class for gcc 3.4, and inline for msvc)
Definition at line 339 of file ParamTypes.hpp.
References set().
std::vector<ParamGroupPtr> pwiz::data::ParamContainer::paramGroupPtrs |
a collection of references to ParamGroups
Definition at line 247 of file ParamTypes.hpp.
Referenced by DemuxHelpersTest::initializeLarge(), initializeTestData(), pwiz::msdata::TextWriter::operator()(), spectrumHasMetadata(), testBinaryDataArray(), testChromatogram(), testComponent(), testComponentList(), testFileDescription(), testInstrumentConfiguration(), testMSData(), testParamContainer(), testParamGroup(), testPrecursor(), testProduct(), testRun(), testSample(), testScan(), testScanList(), testSourceFile(), and testSpectrum().
std::vector<CVParam> pwiz::data::ParamContainer::cvParams |
a collection of controlled vocabulary terms
Definition at line 250 of file ParamTypes.hpp.
Referenced by checkSpectrumInfo(), initializeTestData(), pwiz::identdata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::tradata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), spectrumHasMetadata(), test(), test_v3(), testAnalyzer(), testChromatogram(), testComponent(), testCompound(), testConfiguration(), testContact(), testDataProcessing(), testDetector(), testEvidence(), testFileDescription(), testInstrument(), testInstrumentConfiguration(), testIonisation(), testModelAndManufacturer(), testMSData(), testParamContainer(), testParamGroup(), testPrecursor(), testPrediction(), testProcessingMethod(), testRetentionTime(), testSample(), testScan(), testScanList(), testSearchModification(), testSourceFile(), testSpectrum(), and testValidation().
std::vector<UserParam> pwiz::data::ParamContainer::userParams |
a collection of uncontrolled user terms
Definition at line 253 of file ParamTypes.hpp.
Referenced by initializeTestData(), pwiz::identdata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::tradata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), spectrumHasMetadata(), test(), testAnalyzer(), testCleavageAgent(), testComponent(), testCompound(), testConfiguration(), testContact(), testDataProcessing(), testDetector(), testEvidence(), testFileContent(), testFileDescription(), testIdentifiableParamContainer(), testInstrument(), testIonisation(), testModelAndManufacturer(), testParamContainer(), testParamGroup(), testPepXMLSpecificity(), testPrecursor(), testPrediction(), testProcessingMethod(), testRetentionTime(), testSample(), testScanSettings(), testSearchDatabase(), testSource(), testSourceFile(), and testValidation().