ProteoWizard
Public Member Functions | Public Attributes
pwiz::tradata::Target Struct Reference

A peptide or compound that is to be included or excluded from a target list of precursor m/z values. More...

#include <TraData.hpp>

Inheritance diagram for pwiz::tradata::Target:
pwiz::data::ParamContainer

List of all members.

Public Member Functions

bool empty () const
 returns true iff all members are empty and contain no params
- 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 id
 String label for this target.
PeptidePtr peptidePtr
 Reference to a peptide for which this target is the trigger.
CompoundPtr compoundPtr
 Reference to a compound for which this target is the trigger.
Precursor precursor
 Precursor (Q1) of the target.
RetentionTime retentionTime
 Information about predicted or calibrated retention time.
std::vector< ConfigurationconfigurationList
 List of instrument configurations used in the validation or optimization of the target.
- 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

A peptide or compound that is to be included or excluded from a target list of precursor m/z values.

Definition at line 308 of file TraData.hpp.


Member Function Documentation

bool pwiz::tradata::Target::empty ( ) const

returns true iff all members are empty and contain no params

Reimplemented from pwiz::data::ParamContainer.


Member Data Documentation

std::string pwiz::tradata::Target::id

String label for this target.

Definition at line 311 of file TraData.hpp.

Referenced by pwiz::tradata::TextWriter::operator()(), and testTarget().

PeptidePtr pwiz::tradata::Target::peptidePtr

Reference to a peptide for which this target is the trigger.

Definition at line 314 of file TraData.hpp.

Referenced by pwiz::tradata::TextWriter::operator()(), and testTarget().

CompoundPtr pwiz::tradata::Target::compoundPtr

Reference to a compound for which this target is the trigger.

Definition at line 317 of file TraData.hpp.

Referenced by pwiz::tradata::TextWriter::operator()().

Precursor pwiz::tradata::Target::precursor

Precursor (Q1) of the target.

Definition at line 320 of file TraData.hpp.

Referenced by pwiz::tradata::TextWriter::operator()(), and testTarget().

RetentionTime pwiz::tradata::Target::retentionTime

Information about predicted or calibrated retention time.

Definition at line 323 of file TraData.hpp.

std::vector<Configuration> pwiz::tradata::Target::configurationList

List of instrument configurations used in the validation or optimization of the target.

Definition at line 326 of file TraData.hpp.

Referenced by pwiz::tradata::TextWriter::operator()(), and testTarget().


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