Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

PeakFileOptions Class Reference

#include <OpenMS/FORMAT/PeakFileOptions.h>

List of all members.


Detailed Description

Options for loading files containing peak data.

Public Types

typedef std::vector< int > MSLevels

Public Member Functions

 PeakFileOptions ()
 Default constructor.
 ~PeakFileOptions ()
 Destructor.
void setMetadataOnly (bool only)
 sets whether or not to load only meta data
bool getMetadataOnly () const
 returns whether or not to load only meta data
void setWriteSupplementalData (bool write)
 sets whether or not to write supplemental peak data in MzData files
bool getWriteSupplementalData () const
 returns whether or not to write supplemental peak data in MzData files
void setRTRange (const DRange< 1 > &range)
 restricts the range of RT values for peaks to load
bool hasRTRange () const
 returns true if an RT range has been set
const DRange< 1 > & getRTRange () const
 returns the RT range
void setMZRange (const DRange< 1 > &range)
 restricts the range of MZ values for peaks to load
bool hasMZRange () const
 returns true if an MZ range has been set
const DRange< 1 > & getMZRange () const
 returns the MZ range
void setIntensityRange (const DRange< 1 > &range)
 restricts the range of intensity values for peaks to load
bool hasIntensityRange () const
 returns true if an intensity range has been set
const DRange< 1 > & getIntensityRange () const
 returns the intensity range
void setMSLevels (const MSLevels &levels)
 sets the desired MS levels for peaks to load
void addMSLevel (int level)
 adds a desired MS level for peaks to load
void clearMSLevels ()
 clears the MS levels
bool hasMSLevels () const
 returns true, if MS levels have been set
bool containsMSLevel (int level) const
 returns true, if MS level level has been set
const MSLevelsgetMSLevels () const
 returns the set MS levels

Private Attributes

bool metadata_only_
bool write_supplemental_data_
bool has_rt_range_
bool has_mz_range_
bool has_intensity_range_
DRange< 1 > rt_range_
DRange< 1 > mz_range_
DRange< 1 > intensity_range_
MSLevels ms_levels_

Member Typedef Documentation

typedef std::vector<int> MSLevels


Constructor & Destructor Documentation

PeakFileOptions (  ) 

Default constructor.

~PeakFileOptions (  ) 

Destructor.


Member Function Documentation

void setMetadataOnly ( bool  only  ) 

sets whether or not to load only meta data

bool getMetadataOnly (  )  const

returns whether or not to load only meta data

void setWriteSupplementalData ( bool  write  ) 

sets whether or not to write supplemental peak data in MzData files

bool getWriteSupplementalData (  )  const

returns whether or not to write supplemental peak data in MzData files

void setRTRange ( const DRange< 1 > &  range  ) 

restricts the range of RT values for peaks to load

bool hasRTRange (  )  const

returns true if an RT range has been set

const DRange<1>& getRTRange (  )  const

returns the RT range

void setMZRange ( const DRange< 1 > &  range  ) 

restricts the range of MZ values for peaks to load

bool hasMZRange (  )  const

returns true if an MZ range has been set

const DRange<1>& getMZRange (  )  const

returns the MZ range

void setIntensityRange ( const DRange< 1 > &  range  ) 

restricts the range of intensity values for peaks to load

bool hasIntensityRange (  )  const

returns true if an intensity range has been set

const DRange<1>& getIntensityRange (  )  const

returns the intensity range

void setMSLevels ( const MSLevels levels  ) 

sets the desired MS levels for peaks to load

void addMSLevel ( int  level  ) 

adds a desired MS level for peaks to load

void clearMSLevels (  ) 

clears the MS levels

bool hasMSLevels (  )  const

returns true, if MS levels have been set

bool containsMSLevel ( int  level  )  const

returns true, if MS level level has been set

const MSLevels& getMSLevels (  )  const

returns the set MS levels


Member Data Documentation

bool metadata_only_ [private]

bool write_supplemental_data_ [private]

bool has_rt_range_ [private]

bool has_mz_range_ [private]

bool has_intensity_range_ [private]

DRange<1> rt_range_ [private]

DRange<1> mz_range_ [private]

DRange<1> intensity_range_ [private]

MSLevels ms_levels_ [private]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:44 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1