Implementation of the SampleType from the mzIdentML schema. More...
#include <IdentData.hpp>
Public Member Functions | |
| Sample (const std::string &id_="", const std::string &name_="") | |
| bool | empty () const |
| returns true iff the element contains no params or param groups | |
 Public Member Functions inherited from pwiz::identdata::IdentifiableParamContainer | |
| IdentifiableParamContainer (const std::string &id_="", const std::string &name_="") | |
| virtual | ~IdentifiableParamContainer () |
| 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: | |
| 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) | |
| 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< ContactRolePtr > | contactRole |
| std::vector< boost::shared_ptr < Sample > > | subSamples |
| Public Attributes inherited from pwiz::identdata::IdentifiableParamContainer | |
| std::string | id |
| std::string | name |
| Public Attributes inherited from pwiz::data::ParamContainer | |
| 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 | |
Detailed Description
Implementation of the SampleType from the mzIdentML schema.
A description of the sample analysed by mass spectrometry using CVParams or UserParams. If a composite sample has been analysed, a parent sample should be defined, which references subsamples. This represents any kind of substance used in an experimental workflow, such as whole organisms, cells, DNA, solutions, compounds and experimental substances (gels, arrays etc.).
Definition at line 195 of file IdentData.hpp.
Constructor & Destructor Documentation
| pwiz::identdata::Sample::Sample | ( | const std::string & | id_ = "", |
| const std::string & | name_ = "" |
||
| ) |
Member Function Documentation
|
virtual |
returns true iff the element contains no params or param groups
Reimplemented from pwiz::identdata::IdentifiableParamContainer.
Member Data Documentation
| std::vector<ContactRolePtr> pwiz::identdata::Sample::contactRole |
Definition at line 200 of file IdentData.hpp.
Referenced by pwiz::identdata::TextWriter::operator()(), and testSample().
| std::vector<boost::shared_ptr<Sample> > pwiz::identdata::Sample::subSamples |
Definition at line 201 of file IdentData.hpp.
Referenced by pwiz::identdata::TextWriter::operator()(), and testSample().
The documentation for this struct was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/identdata/IdentData.hpp
