ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::Sample Struct Reference

Expansible description of the sample used to generate the dataset, named in sampleName. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::Sample:
pwiz::data::ParamContainer

Public Member Functions

 Sample (const std::string _id="", const std::string _name="")
 
bool empty () const
 returns true iff the element contains no params and all members are empty or null More...
 
- Public Member Functions inherited from pwiz::data::ParamContainer
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::string id
 a unique identifier across the samples with which to reference this sample description. More...
 
std::string name
 an optional name for the sample description, mostly intended as a quick mnemonic. More...
 
- Public Attributes inherited from pwiz::data::ParamContainer
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

Expansible description of the sample used to generate the dataset, named in sampleName.

Definition at line 100 of file MSData.hpp.

Constructor & Destructor Documentation

§ Sample()

pwiz::msdata::Sample::Sample ( const std::string  _id = "",
const std::string  _name = "" 
)

Member Function Documentation

§ empty()

bool pwiz::msdata::Sample::empty ( ) const

returns true iff the element contains no params and all members are empty or null

Member Data Documentation

§ id

std::string pwiz::msdata::Sample::id

a unique identifier across the samples with which to reference this sample description.

Definition at line 103 of file MSData.hpp.

Referenced by pwiz::msdata::TextWriter::operator()().

§ name

std::string pwiz::msdata::Sample::name

an optional name for the sample description, mostly intended as a quick mnemonic.

Definition at line 106 of file MSData.hpp.

Referenced by pwiz::msdata::TextWriter::operator()().


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