ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::Chromatogram Struct Reference

A single chromatogram. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::Chromatogram:
pwiz::msdata::ChromatogramIdentity pwiz::data::ParamContainer

Public Member Functions

 Chromatogram ()
 
bool empty () const
 returns true iff the element contains no params and all members are empty or null More...
 
void getTimeIntensityPairs (std::vector< TimeIntensityPair > &output) const
 copy binary data arrays into time-intensity pair array More...
 
void getTimeIntensityPairs (TimeIntensityPair *output, size_t expectedSize) const
 copy binary data arrays into time-intensity pair array note: this overload is to allow client to allocate own buffer; the client must determine the correct size beforehand, or an exception will be thrown More...
 
BinaryDataArrayPtr getTimeArray () const
 get time array (may be null) More...
 
BinaryDataArrayPtr getIntensityArray () const
 get intensity array (may be null) More...
 
void setTimeIntensityPairs (const std::vector< TimeIntensityPair > &input, CVID timeUnits, CVID intensityUnits)
 set binary data arrays More...
 
void setTimeIntensityPairs (const TimeIntensityPair *input, size_t size, CVID timeUnits, CVID intensityUnits)
 set binary data arrays More...
 
void setTimeIntensityArrays (const std::vector< double > &timeArray, const std::vector< double > &intensityArray, CVID timeUnits, CVID intensityUnits)
 set time and intensity arrays separately (they must be the same size) More...
 
- Public Member Functions inherited from pwiz::msdata::ChromatogramIdentity
 ChromatogramIdentity ()
 
- Public Member Functions inherited from pwiz::data::ParamContainer
CVParam cvParam (CVID cvid) const
 finds cvid in the container: More...
 
CVParam cvParamChild (CVID cvid) const
 finds child of cvid in the container: More...
 
std::vector< CVParamcvParamChildren (CVID cvid) const
 finds all children of cvid in the container: More...
 
bool hasCVParam (CVID cvid) const
 returns true iff cvParams contains exact cvid (recursive) More...
 
bool hasCVParamChild (CVID cvid) const
 returns true iff cvParams contains a child (is_a) of cvid (recursive) More...
 
UserParam userParam (const std::string &) const
 finds UserParam with specified name More...
 
void set (CVID cvid, const std::string &value="", CVID units=CVID_Unknown)
 set/add a CVParam (not recursive) More...
 
void set (CVID cvid, double value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive) More...
 
void set (CVID cvid, int value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive) More...
 
template<typename value_type >
void set (CVID cvid, value_type value, CVID units=CVID_Unknown)
 set/add a CVParam (not recursive) More...
 
bool empty () const
 returns true iff the element contains no params or param groups More...
 
void clear ()
 clears the collections More...
 
bool operator== (const ParamContainer &that) const
 returns true iff this and that have the exact same cvParams and userParams More...
 
bool operator!= (const ParamContainer &that) const
 returns !(this==that) More...
 
template<>
void set (CVID cvid, bool value, CVID units)
 special case for bool (outside the class for gcc 3.4, and inline for msvc) More...
 

Public Attributes

size_t defaultArrayLength
 default length of binary data arrays contained in this element. More...
 
DataProcessingPtr dataProcessingPtr
 this attribute can optionally reference the 'id' of the appropriate dataProcessing. More...
 
Precursor precursor
 description of precursor ion information (i.e. Q1 settings) More...
 
Product product
 description of product ion information (i.e. Q3 settings) More...
 
std::vector< BinaryDataArrayPtrbinaryDataArrayPtrs
 list of binary data arrays. More...
 
- Public Attributes inherited from pwiz::msdata::ChromatogramIdentity
size_t index
 the zero-based, consecutive index of the chromatogram in the ChromatogramList. More...
 
std::string id
 a unique identifier for this chromatogram. It should be expected that external files may use this identifier together with the mzML filename or accession to reference a particular chromatogram. More...
 
boost::iostreams::stream_offset sourceFilePosition
 for file-based MSData implementations, this attribute may refer to the chromatogram's position in the file More...
 
- Public Attributes inherited from pwiz::data::ParamContainer
std::vector< ParamGroupPtrparamGroupPtrs
 a collection of references to ParamGroups More...
 
std::vector< CVParamcvParams
 a collection of controlled vocabulary terms More...
 
std::vector< UserParamuserParams
 a collection of uncontrolled user terms More...
 

Detailed Description

A single chromatogram.

Definition at line 573 of file MSData.hpp.

Constructor & Destructor Documentation

§ Chromatogram()

pwiz::msdata::Chromatogram::Chromatogram ( )
inline

Definition at line 590 of file MSData.hpp.

590 : defaultArrayLength(0) {}
size_t defaultArrayLength
default length of binary data arrays contained in this element.
Definition: MSData.hpp:576

Member Function Documentation

§ empty()

bool pwiz::msdata::Chromatogram::empty ( ) const

returns true iff the element contains no params and all members are empty or null

§ getTimeIntensityPairs() [1/2]

void pwiz::msdata::Chromatogram::getTimeIntensityPairs ( std::vector< TimeIntensityPair > &  output) const

copy binary data arrays into time-intensity pair array

§ getTimeIntensityPairs() [2/2]

void pwiz::msdata::Chromatogram::getTimeIntensityPairs ( TimeIntensityPair output,
size_t  expectedSize 
) const

copy binary data arrays into time-intensity pair array note: this overload is to allow client to allocate own buffer; the client must determine the correct size beforehand, or an exception will be thrown

§ getTimeArray()

BinaryDataArrayPtr pwiz::msdata::Chromatogram::getTimeArray ( ) const

get time array (may be null)

§ getIntensityArray()

BinaryDataArrayPtr pwiz::msdata::Chromatogram::getIntensityArray ( ) const

get intensity array (may be null)

§ setTimeIntensityPairs() [1/2]

void pwiz::msdata::Chromatogram::setTimeIntensityPairs ( const std::vector< TimeIntensityPair > &  input,
CVID  timeUnits,
CVID  intensityUnits 
)

set binary data arrays

§ setTimeIntensityPairs() [2/2]

void pwiz::msdata::Chromatogram::setTimeIntensityPairs ( const TimeIntensityPair input,
size_t  size,
CVID  timeUnits,
CVID  intensityUnits 
)

set binary data arrays

§ setTimeIntensityArrays()

void pwiz::msdata::Chromatogram::setTimeIntensityArrays ( const std::vector< double > &  timeArray,
const std::vector< double > &  intensityArray,
CVID  timeUnits,
CVID  intensityUnits 
)

set time and intensity arrays separately (they must be the same size)

Member Data Documentation

§ defaultArrayLength

size_t pwiz::msdata::Chromatogram::defaultArrayLength

default length of binary data arrays contained in this element.

Definition at line 576 of file MSData.hpp.

Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), and testChromatogram().

§ dataProcessingPtr

DataProcessingPtr pwiz::msdata::Chromatogram::dataProcessingPtr

this attribute can optionally reference the 'id' of the appropriate dataProcessing.

Definition at line 579 of file MSData.hpp.

Referenced by pwiz::msdata::TextWriter::operator()(), and testChromatogram().

§ precursor

Precursor pwiz::msdata::Chromatogram::precursor

description of precursor ion information (i.e. Q1 settings)

Definition at line 582 of file MSData.hpp.

§ product

Product pwiz::msdata::Chromatogram::product

description of product ion information (i.e. Q3 settings)

Definition at line 585 of file MSData.hpp.

§ binaryDataArrayPtrs

std::vector<BinaryDataArrayPtr> pwiz::msdata::Chromatogram::binaryDataArrayPtrs

list of binary data arrays.

Definition at line 588 of file MSData.hpp.

Referenced by initializeTestData(), pwiz::msdata::TextWriter::operator()(), and testChromatogram().


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