Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
TrypticIterator.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_TRYPTICITERATOR_H
36 #define OPENMS_CHEMISTRY_TRYPTICITERATOR_H
37 
40 #include <vector>
41 
42 namespace OpenMS
43 {
48  class OPENMS_DLLAPI TrypticIterator :
49  public PepIterator
50  {
51 
52 public:
53 
54  typedef std::pair<String, String> FASTAEntry;
66  virtual ~TrypticIterator();
67 
73  virtual FASTAEntry operator*();
74 
80  virtual PepIterator & operator++();
81 
87  virtual PepIterator * operator++(int i);
88 
94  virtual void setFastaFile(const String & f);
95 
100  virtual String getFastaFile();
101 
106  virtual void setTolerance(double)
107  {
108  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
109  }
110 
116  virtual double getTolerance()
117  {
118  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
119  }
120 
125  virtual void setSpectrum(const std::vector<double> &)
126  {
127  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
128  }
129 
135  virtual const std::vector<double> & getSpectrum()
136  {
137  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
138  }
139 
145  virtual bool begin();
146 
152  virtual bool isAtEnd();
153 
158  virtual bool isDigestingEnd(char aa1, char aa2);
159 
164  static const String getProductName()
165  {
166  return "TrypticIterator";
167  }
168 
173  static PepIterator * create()
174  {
175  return new TrypticIterator;
176  }
177 
178 protected:
183  virtual std::string next_();
184 
189  bool hasNext_();
190 
194  void goToNextAA_();
195 
197 
198  std::string actual_pep_;
199 
200  bool is_at_end_;
201 
203 
204  FASTAEntry f_entry_;
205 
206  unsigned int b_, e_;
207 
208 
209 
210  };
211 
212 }
213 #endif //OPENMS_CHEMISTRY_EDWARDSLIPPERTITERATOR_H
static const String getProductName()
needed by Factory
Definition: TrypticIterator.h:164
A more convenient string class.
Definition: String.h:57
Abstract base class for different peptide iterators.
Definition: PepIterator.h:48
FASTAEntry f_entry_
actual fasta entry
Definition: TrypticIterator.h:204
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
static PepIterator * create()
needed by Factory
Definition: TrypticIterator.h:173
unsigned int e_
to ints representing a position within the actual string (b = begin, e = end)
Definition: TrypticIterator.h:206
std::string actual_pep_
actual peptide
Definition: TrypticIterator.h:198
DPosition< D, TCoordinateType > operator*(DPosition< D, TCoordinateType > position, typename DPosition< D, TCoordinateType >::CoordinateType scalar)
Scalar multiplication (a bit inefficient)
Definition: DPosition.h:421
bool is_at_end_
indicates if iterator is at end
Definition: TrypticIterator.h:200
virtual double getTolerance()
getter for tolerance
Definition: TrypticIterator.h:116
String f_file_
fasta file location
Definition: TrypticIterator.h:196
virtual void setSpectrum(const std::vector< double > &)
setter for spectrum
Definition: TrypticIterator.h:125
virtual const std::vector< double > & getSpectrum()
getter for spectrum
Definition: TrypticIterator.h:135
std::pair< String, String > FASTAEntry
Definition: TrypticIterator.h:54
virtual void setTolerance(double)
setter for tolerance
Definition: TrypticIterator.h:106
finds all tryptic Peptides with every missed cleavage
Definition: TrypticIterator.h:48
Not implemented exception.
Definition: Exception.h:437
PepIterator * f_iterator_
FastaIterator.
Definition: TrypticIterator.h:202

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