ProteoWizard
Public Member Functions
pwiz::identdata::Contact Struct Reference

Implementation of ContactType from mzIdentML. More...

#include <IdentData.hpp>

Inheritance diagram for pwiz::identdata::Contact:
pwiz::identdata::IdentifiableParamContainer pwiz::data::ParamContainer pwiz::identdata::Organization pwiz::identdata::Person

List of all members.

Public Member Functions

 Contact (const std::string &id_="", const std::string &name_="")
virtual ~Contact ()
virtual 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)

Additional Inherited Members

- 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 ContactType from mzIdentML.

A contact is either a person or an organization.

Definition at line 117 of file IdentData.hpp.


Constructor & Destructor Documentation

pwiz::identdata::Contact::Contact ( const std::string &  id_ = "",
const std::string &  name_ = "" 
)
virtual pwiz::identdata::Contact::~Contact ( )
inlinevirtual

Definition at line 121 of file IdentData.hpp.

{}

Member Function Documentation

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

returns true iff the element contains no params or param groups

Reimplemented from pwiz::identdata::IdentifiableParamContainer.

Reimplemented in pwiz::identdata::Person, and pwiz::identdata::Organization.


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