ProteoWizard
Public Member Functions | Public Attributes
pwiz::data::CVParam Struct Reference

represents a tag-value pair, where the tag comes from the controlled vocabulary More...

#include <ParamTypes.hpp>

Inheritance diagram for pwiz::data::CVParam:
pwiz::identdata::ContactRole pwiz::identdata::IonType

List of all members.

Public Member Functions

 CVParam (CVID _cvid, float _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, double _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, int _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, long _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, unsigned int _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, unsigned long _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, std::string _value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, const char *_value, CVID _units=CVID_Unknown)
 CVParam (CVID _cvid, bool _value, CVID _units=CVID_Unknown)
 special case for bool (no lexical_cast)
 CVParam (CVID _cvid=CVID_Unknown)
 constructor for non-valued CVParams
 ~CVParam ()
template<typename value_type >
value_type valueAs () const
 templated value access with type conversion
std::string name () const
 convenience function to return string for the cvid
std::string unitsName () const
 convenience function to return string for the units
double timeInSeconds () const
 convenience function to return time in seconds (throws if units not a time unit)
std::string valueFixedNotation () const
 convenience function to return value without scientific notation (throws if not a double)
bool operator== (const CVParam &that) const
 equality operator
bool operator!= (const CVParam &that) const
 inequality operator
bool empty () const

Public Attributes

CVID cvid
std::string value
CVID units

Detailed Description

represents a tag-value pair, where the tag comes from the controlled vocabulary

Definition at line 44 of file ParamTypes.hpp.

Constructor & Destructor Documentation

pwiz::data::CVParam::CVParam ( CVID  _cvid,
float  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 50 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
double  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 56 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
int  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 62 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
long  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 68 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
unsigned int  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 74 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
unsigned long  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 80 of file ParamTypes.hpp.

: cvid(_cvid),
value(boost::lexical_cast<std::string>(_value)),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
std::string  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 86 of file ParamTypes.hpp.

: cvid(_cvid),
value(_value),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
const char *  _value,
CVID  _units = CVID_Unknown 
)
inline

Definition at line 92 of file ParamTypes.hpp.

: cvid(_cvid),
value(_value),
units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid,
bool  _value,
CVID  _units = CVID_Unknown 
)
inline

special case for bool (no lexical_cast)

Definition at line 99 of file ParamTypes.hpp.

: cvid(_cvid), value(_value ? "true" : "false"), units(_units)
{}
pwiz::data::CVParam::CVParam ( CVID  _cvid = CVID_Unknown)
inline

constructor for non-valued CVParams

Definition at line 104 of file ParamTypes.hpp.

: cvid(_cvid), units(CVID_Unknown)
{}
pwiz::data::CVParam::~CVParam ( )

Member Function Documentation

bool pwiz::data::CVParam::valueAs< bool > ( ) const
inline

templated value access with type conversion

special case for bool (no lexical_cast) (this has to be outside the class for gcc 3.4, inline for msvc)

Definition at line 112 of file ParamTypes.hpp.

References boost::lexical_cast(), and pwiz::msdata::id::value().

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

{
return !value.empty() ? boost::lexical_cast<value_type>(value)
: boost::lexical_cast<value_type>(0);
}
std::string pwiz::data::CVParam::name ( ) const

convenience function to return string for the cvid

std::string pwiz::data::CVParam::unitsName ( ) const

convenience function to return string for the units

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

double pwiz::data::CVParam::timeInSeconds ( ) const

convenience function to return time in seconds (throws if units not a time unit)

Referenced by test().

std::string pwiz::data::CVParam::valueFixedNotation ( ) const

convenience function to return value without scientific notation (throws if not a double)

bool pwiz::data::CVParam::operator== ( const CVParam &  that) const
inline

equality operator

Definition at line 131 of file ParamTypes.hpp.

References cvid, units, value, and pwiz::msdata::id::value().

{
return that.cvid==cvid && that.value==value && that.units==units;
}
bool pwiz::data::CVParam::operator!= ( const CVParam &  that) const
inline

inequality operator

Definition at line 137 of file ParamTypes.hpp.

References pwiz::data::operator==().

{
return !operator==(that);
}
bool pwiz::data::CVParam::empty ( ) const
inline

Reimplemented in pwiz::identdata::IonType, and pwiz::identdata::ContactRole.

Definition at line 142 of file ParamTypes.hpp.

References CVID_Unknown, and pwiz::msdata::id::value().

Referenced by MSLevelSorter::less(), pwiz::identdata::TextWriter::operator()(), testCVParam(), testSearchDatabase(), testSourceFile(), and testSpectraData().

{return cvid==CVID_Unknown && value.empty() && units==CVID_Unknown;}

Member Data Documentation

CVID pwiz::data::CVParam::cvid

Definition at line 46 of file ParamTypes.hpp.

Referenced by EvenMS2Predicate::accept(), checkSpectrumInfo(), WriteCVParam::operator()(), pwiz::tradata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), pwiz::data::CVParamIs::operator()(), pwiz::data::CVParamIsChildOf::operator()(), operator==(), test(), test_v3(), testContactRole(), testCVParam(), testIonType(), testParamContainer(), testSearchDatabase(), testSearchModification(), testSoftware(), testSourceFile(), testSpectraData(), and testSpectrumIdentificationProtocol().

std::string pwiz::data::CVParam::value

Definition at line 47 of file ParamTypes.hpp.

Referenced by checkSpectrumInfo(), WriteCVParam::operator()(), pwiz::tradata::TextWriter::operator()(), pwiz::msdata::TextWriter::operator()(), pwiz::identdata::TextWriter::operator()(), operator==(), test(), test_v3(), testAmbiguousResidue(), testCVParam(), and testParamContainer().

CVID pwiz::data::CVParam::units

Definition at line 48 of file ParamTypes.hpp.

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

The documentation for this struct was generated from the following file:
Generated on Mon Nov 26 2012 18:05:52 for ProteoWizard by   doxygen 1.8.1.1