ProteoWizard
Public Member Functions | Public Attributes
pwiz::identdata::DBSequence Struct Reference

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

#include <IdentData.hpp>

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

List of all members.

Public Member Functions

 DBSequence (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< 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)
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

int length
std::string accession
SearchDatabasePtr searchDatabasePtr
std::string seq
- 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
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms
std::vector< UserParamuserParams
 a collection of uncontrolled user terms

Detailed Description

Implementation of DBSequenceType from the mzIdentML schema.

A database sequence from the specified SearchDatabase (nucleic acid or amino acid). If the sequence is nucleic acid, the source nucleic acid sequence should be given in the seq attribute rather than a translated sequence.

Definition at line 296 of file IdentData.hpp.


Constructor & Destructor Documentation

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

Member Function Documentation

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

returns true iff the element contains no params or param groups

Reimplemented from pwiz::identdata::IdentifiableParamContainer.


Member Data Documentation

int pwiz::identdata::DBSequence::length

Definition at line 301 of file IdentData.hpp.

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

std::string pwiz::identdata::DBSequence::accession

Definition at line 302 of file IdentData.hpp.

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

SearchDatabasePtr pwiz::identdata::DBSequence::searchDatabasePtr

Definition at line 303 of file IdentData.hpp.

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

std::string pwiz::identdata::DBSequence::seq

Definition at line 305 of file IdentData.hpp.

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


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