ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::identdata::SearchDatabase Struct Reference

Implementation of SearchDatabaseType from the mzIdentML schema. More...

#include <IdentData.hpp>

Inheritance diagram for pwiz::identdata::SearchDatabase:
pwiz::identdata::IdentifiableParamContainer pwiz::data::ParamContainer

Public Member Functions

 SearchDatabase (const std::string &id_="", const std::string &name_="")
 
bool empty () const
 
- 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: 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 location
 
std::string version
 
std::string releaseDate
 
long numDatabaseSequences
 
long numResidues
 
CVParam fileFormat
 
ParamContainer databaseName
 
- Public Attributes inherited from pwiz::identdata::IdentifiableParamContainer
std::string id
 
std::string name
 
- 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

Implementation of SearchDatabaseType from the mzIdentML schema.

A database for searching mass spectra. Examples include a set of amino acid sequence entries, or annotated spectra libraries.

Definition at line 270 of file IdentData.hpp.

Constructor & Destructor Documentation

§ SearchDatabase()

pwiz::identdata::SearchDatabase::SearchDatabase ( const std::string &  id_ = "",
const std::string &  name_ = "" 
)

Member Function Documentation

§ empty()

bool pwiz::identdata::SearchDatabase::empty ( ) const
virtual

Member Data Documentation

§ location

std::string pwiz::identdata::SearchDatabase::location

Definition at line 275 of file IdentData.hpp.

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

§ version

std::string pwiz::identdata::SearchDatabase::version

Definition at line 276 of file IdentData.hpp.

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

§ releaseDate

std::string pwiz::identdata::SearchDatabase::releaseDate

Definition at line 277 of file IdentData.hpp.

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

§ numDatabaseSequences

long pwiz::identdata::SearchDatabase::numDatabaseSequences

Definition at line 278 of file IdentData.hpp.

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

§ numResidues

long pwiz::identdata::SearchDatabase::numResidues

Definition at line 279 of file IdentData.hpp.

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

§ fileFormat

CVParam pwiz::identdata::SearchDatabase::fileFormat

Definition at line 281 of file IdentData.hpp.

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

§ databaseName

ParamContainer pwiz::identdata::SearchDatabase::databaseName

Definition at line 282 of file IdentData.hpp.

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


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