Description of the source file, including location and type. More...
#include <MSData.hpp>
Public Member Functions | |
| SourceFile (const std::string _id="", const std::string _name="", const std::string _location="") | |
| bool | empty () const |
| returns true iff the element contains no params and all members are empty or null | |
 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::string | id |
| an identifier for this file. | |
| std::string | name |
| name of the source file, without reference to location (either URI or local path). | |
| std::string | location |
| URI-formatted location where the file was retrieved. | |
| 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
Description of the source file, including location and type.
Definition at line 52 of file MSData.hpp.
Constructor & Destructor Documentation
| pwiz::msdata::SourceFile::SourceFile | ( | const std::string | _id = "", |
| const std::string | _name = "", |
||
| const std::string | _location = "" |
||
| ) |
Member Function Documentation
| bool pwiz::msdata::SourceFile::empty | ( | ) | const |
returns true iff the element contains no params and all members are empty or null
Reimplemented from pwiz::data::ParamContainer.
Member Data Documentation
| std::string pwiz::msdata::SourceFile::id |
an identifier for this file.
Definition at line 55 of file MSData.hpp.
Referenced by pwiz::msdata::TextWriter::operator()().
| std::string pwiz::msdata::SourceFile::name |
name of the source file, without reference to location (either URI or local path).
Definition at line 58 of file MSData.hpp.
Referenced by pwiz::msdata::TextWriter::operator()().
| std::string pwiz::msdata::SourceFile::location |
URI-formatted location where the file was retrieved.
Definition at line 61 of file MSData.hpp.
Referenced by pwiz::msdata::TextWriter::operator()().
The documentation for this struct was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/MSData.hpp
