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

The structure into which encoded binary data goes. Byte ordering is always little endian (Intel style). Computers using a different endian style MUST convert to/from little endian when writing/reading mzML. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::BinaryDataArray:
pwiz::data::ParamContainer

Public Member Functions

bool empty () const
 returns true iff the element contains no params and all members are empty or null
 
- 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:
 
template<typename ValueT >
ValueT cvParamValueOrDefault (CVID cvid, ValueT defaultValue) const
 finds cvid in the container:
 
template<typename ValueT >
ValueT cvParamChildValueOrDefault (CVID cvid, ValueT defaultValue) 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)
 
bool empty () const
 returns true iff the element contains no params or param groups
 
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

DataProcessingPtr dataProcessingPtr
 this optional attribute may reference the 'id' attribute of the appropriate dataProcessing.
 
pwiz::util::BinaryData< double > data
 the binary data.
 
- 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

The structure into which encoded binary data goes. Byte ordering is always little endian (Intel style). Computers using a different endian style MUST convert to/from little endian when writing/reading mzML.

Definition at line 404 of file MSData.hpp.

Member Function Documentation

◆ empty()

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

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

Member Data Documentation

◆ dataProcessingPtr

DataProcessingPtr pwiz::msdata::BinaryDataArray::dataProcessingPtr

this optional attribute may reference the 'id' attribute of the appropriate dataProcessing.

Definition at line 407 of file MSData.hpp.

Referenced by testBinaryDataArray(), and testBinaryDataArray().

◆ data

pwiz::util::BinaryData<double> pwiz::msdata::BinaryDataArray::data

the binary data.

Definition at line 410 of file MSData.hpp.

Referenced by makeSpectrumPtr(), testBinaryDataArray(), testBinaryDataArray(), and testBinaryDataArrayExternalMetadata().


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