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

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

#include <IdentData.hpp>

Inheritance diagram for pwiz::identdata::IonType:
pwiz::data::CVParam

Public Member Functions

 IonType ()
 
bool empty () const
 
- Public Member Functions inherited from pwiz::data::CVParam
 CVParam (CVID _cvid, float _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, double _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, int _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, long _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, unsigned int _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, unsigned long _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, std::string _value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, const char *_value, CVID _units=CVID_Unknown)
 
 CVParam (CVID _cvid, bool _value, CVID _units=CVID_Unknown)
 special case for bool (no lexical_cast) More...
 
 CVParam (CVID _cvid=CVID_Unknown)
 constructor for non-valued CVParams More...
 
 ~CVParam ()
 
template<typename value_type >
value_type valueAs () const
 templated value access with type conversion More...
 
std::string name () const
 convenience function to return string for the cvid More...
 
std::string unitsName () const
 convenience function to return string for the units More...
 
double timeInSeconds () const
 convenience function to return time in seconds (throws if units not a time unit) More...
 
std::string valueFixedNotation () const
 convenience function to return value without scientific notation (throws if not a double) More...
 
bool operator== (const CVParam &that) const
 equality operator More...
 
bool operator!= (const CVParam &that) const
 inequality operator More...
 
bool empty () const
 
template<>
bool valueAs () const
 special case for bool (no lexical_cast) (this has to be outside the class for gcc 3.4, inline for msvc) More...
 

Public Attributes

std::vector< int > index
 
int charge
 
std::vector< FragmentArrayPtr > fragmentArray
 
- Public Attributes inherited from pwiz::data::CVParam
CVID cvid
 
std::string value
 
CVID units
 

Detailed Description

Implementation of IonTypeType from the mzIdentML schema.

IonType defines the index of fragmentation ions being reported, importing a CV term for the type of ion e.g. b ion. Example: if b3 b7 b8 and b10 have been identified, the index attribute will contain 3 7 8 10, and the corresponding values will be reported in parallel arrays below

Definition at line 607 of file IdentData.hpp.

Constructor & Destructor Documentation

§ IonType()

pwiz::identdata::IonType::IonType ( )

Member Function Documentation

§ empty()

bool pwiz::identdata::IonType::empty ( ) const

Member Data Documentation

§ index

std::vector<int> pwiz::identdata::IonType::index

Definition at line 611 of file IdentData.hpp.

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

§ charge

int pwiz::identdata::IonType::charge

Definition at line 612 of file IdentData.hpp.

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

§ fragmentArray

std::vector<FragmentArrayPtr> pwiz::identdata::IonType::fragmentArray

Definition at line 613 of file IdentData.hpp.

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


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