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

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

#include <IdentData.hpp>

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

List of all members.

Public Member Functions

 Person (const std::string &id_="", const std::string &name_="")
virtual bool empty () const
 returns true iff the element contains no params or param groups
- Public Member Functions inherited from pwiz::identdata::Contact
 Contact (const std::string &id_="", const std::string &name_="")
virtual ~Contact ()
- 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

std::string lastName
std::string firstName
std::string midInitials
std::vector< OrganizationPtr > affiliations

Detailed Description

Implementation of PersonType from the mzIdentML schema.

A person's name and contact details. Any additional information such as the address, contact email etc. should be supplied using CV parameters or user parameters.

Definition at line 152 of file IdentData.hpp.


Constructor & Destructor Documentation

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

Member Function Documentation

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

returns true iff the element contains no params or param groups

Reimplemented from pwiz::identdata::Contact.


Member Data Documentation

std::string pwiz::identdata::Person::lastName

Definition at line 157 of file IdentData.hpp.

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

std::string pwiz::identdata::Person::firstName

Definition at line 158 of file IdentData.hpp.

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

std::string pwiz::identdata::Person::midInitials

Definition at line 159 of file IdentData.hpp.

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

std::vector<OrganizationPtr> pwiz::identdata::Person::affiliations

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