Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
PepIterator.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-2017.
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: Timo Sachsenberg $
32 // $Authors: Chris Bauer $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_CHEMISTRY_PEPITERATOR_H
36 #define OPENMS_CHEMISTRY_PEPITERATOR_H
37 
39 
40 namespace OpenMS
41 {
42 
48  class OPENMS_DLLAPI PepIterator
49  {
50 
51 public:
52 
53  typedef std::pair<String, String> FASTAEntry;
54 
58  PepIterator();
59 
63  virtual ~PepIterator();
64 
68  PepIterator(const PepIterator & source);
69 
75  virtual FASTAEntry operator*() = 0;
76 
82  virtual PepIterator & operator++() = 0;
83 
89  virtual PepIterator * operator++(int) = 0;
90 
97  virtual void setFastaFile(const String & f) = 0;
98 
103  virtual String getFastaFile() = 0;
104 
110  virtual void setSpectrum(const std::vector<double> & s) = 0;
111 
116  virtual const std::vector<double> & getSpectrum() = 0;
117 
123  virtual void setTolerance(double t) = 0;
124 
129  virtual double getTolerance() = 0;
130 
134  virtual bool begin() = 0;
135 
139  virtual bool isAtEnd() = 0;
140 
145  static void registerChildren();
146 
147  };
148 }
149 #endif // OPENMS_CHEMISTRY_PEPITERATOR_H
A more convenient string class.
Definition: String.h:57
Abstract base class for different peptide iterators.
Definition: PepIterator.h:48
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
DPosition< D, TCoordinateType > operator*(DPosition< D, TCoordinateType > position, typename DPosition< D, TCoordinateType >::CoordinateType scalar)
Scalar multiplication (a bit inefficient)
Definition: DPosition.h:421
std::pair< String, String > FASTAEntry
Definition: PepIterator.h:53

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:03 using doxygen 1.8.13