ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::tradata::Software Struct Reference

#include <TraData.hpp>

Inheritance diagram for pwiz::tradata::Software:
pwiz::data::ParamContainer

Public Member Functions

 Software (const std::string &_id="")
 
 Software (const std::string &_id, const CVParam &_param, const std::string &_version)
 
bool empty () const
 returns true iff all members are empty and contain no params
 
- 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:
 
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::string id
 Identifier for the software to be used for referencing within a document.
 
std::string version
 Version of the software program described.
 
- 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

Definition at line 70 of file TraData.hpp.

Constructor & Destructor Documentation

◆ Software() [1/2]

pwiz::tradata::Software::Software ( const std::string &  _id = "")

◆ Software() [2/2]

pwiz::tradata::Software::Software ( const std::string &  _id,
const CVParam _param,
const std::string &  _version 
)

Member Function Documentation

◆ empty()

bool pwiz::tradata::Software::empty ( ) const

returns true iff all members are empty and contain no params

Member Data Documentation

◆ id

std::string pwiz::tradata::Software::id

Identifier for the software to be used for referencing within a document.

Definition at line 73 of file TraData.hpp.

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

◆ version

std::string pwiz::tradata::Software::version

Version of the software program described.

Definition at line 76 of file TraData.hpp.

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


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