Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
PeakFileOptions.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Andreas Bertsch $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_OPTIONS_PEAKFILEOPTIONS_H
36 #define OPENMS_FORMAT_OPTIONS_PEAKFILEOPTIONS_H
37 
39 
40 #include <vector>
41 
42 namespace OpenMS
43 {
47  class OPENMS_DLLAPI PeakFileOptions
48  {
49 public:
55  ~PeakFileOptions();
56 
58 
59  void setMetadataOnly(bool only);
62  bool getMetadataOnly() const;
64 
66 
67  void setWriteSupplementalData(bool write);
70  bool getWriteSupplementalData() const;
72 
74 
75  void setRTRange(const DRange<1> & range);
78  bool hasRTRange() const;
80  const DRange<1> & getRTRange() const;
82 
84 
85  void setMZRange(const DRange<1> & range);
88  bool hasMZRange() const;
90  const DRange<1> & getMZRange() const;
92 
94 
95  void setIntensityRange(const DRange<1> & range);
98  bool hasIntensityRange() const;
100  const DRange<1> & getIntensityRange() const;
102 
111  void setMSLevels(const std::vector<Int> & levels);
114  void addMSLevel(int level);
116  void clearMSLevels();
118  bool hasMSLevels() const;
120  bool containsMSLevel(int level) const;
122  const std::vector<Int> & getMSLevels() const;
124 
131  //Sets if data should be compressed when writing
132  void setCompression(bool compress);
133  //returns @c true, if data should be compressed when writing
134  bool getCompression() const;
136 
143  //Sets if mz-data should be stored with 32bit or 64bit precision
144  void setMz32Bit(bool mz_32_bit);
145  //returns @c true, if mz-data should be stored with 32bit precision
146  bool getMz32Bit() const;
147  //Sets if intensity data should be stored with 32bit or 64bit precision
148  void setIntensity32Bit(bool int_32_bit);
149  //returns @c true, if intensity data should be stored with 32bit precision
150  bool getIntensity32Bit() const;
152 
153 private:
164  std::vector<Int> ms_levels_;
166  };
167 
168 } // namespace OpenMS
169 
170 #endif // OPENMS_FORMAT_OPTIONS_PEAKFILEOPTIONS_H
bool has_intensity_range_
Definition: PeakFileOptions.h:158
bool metadata_only_
Definition: PeakFileOptions.h:154
DRange< 1 > rt_range_
Definition: PeakFileOptions.h:161
bool int_32_bit_
Definition: PeakFileOptions.h:160
bool write_supplemental_data_
Definition: PeakFileOptions.h:155
DRange< 1 > mz_range_
Definition: PeakFileOptions.h:162
bool has_rt_range_
Definition: PeakFileOptions.h:156
bool has_mz_range_
Definition: PeakFileOptions.h:157
DRange< 1 > intensity_range_
Definition: PeakFileOptions.h:163
bool zlib_compression_
Definition: PeakFileOptions.h:165
Options for loading files containing peak data.
Definition: PeakFileOptions.h:47
bool mz_32_bit_
Definition: PeakFileOptions.h:159
std::vector< Int > ms_levels_
Definition: PeakFileOptions.h:164

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:19 using doxygen 1.8.5