Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
FASTAFile.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-2015.
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: Sandro Andreotti $
32 // $Authors: Nico Pfeifer $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_FASTAFILE_H
36 #define OPENMS_FORMAT_FASTAFILE_H
37 
40 
41 #include <vector>
42 
43 namespace OpenMS
44 {
48  class OPENMS_DLLAPI FASTAFile
49  {
50 public:
51 
61  struct FASTAEntry
62  {
66 
68  identifier(""),
69  description(""),
70  sequence("")
71  {
72  }
73 
74  FASTAEntry(String id, String desc, String seq) :
75  identifier(id),
76  description(desc),
77  sequence(seq)
78  {
79  }
80 
81  bool operator==(const FASTAEntry& rhs) const
82  {
83  return identifier == rhs.identifier
84  && description == rhs.description
85  && sequence == rhs.sequence;
86  }
87 
88  };
89 
91  FASTAFile();
92 
94  virtual ~FASTAFile();
95 
102  void load(const String& filename, std::vector<FASTAEntry>& data);
103 
109  void store(const String& filename, const std::vector<FASTAEntry>& data) const;
110 
111  };
112 
113 } // namespace OpenMS
114 
115 #endif // OPENMS_FORMAT_FASTAFILE_H
A more convenient string class.
Definition: String.h:57
FASTAEntry()
Definition: FASTAFile.h:67
bool operator==(const FASTAEntry &rhs) const
Definition: FASTAFile.h:81
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
FASTAEntry(String id, String desc, String seq)
Definition: FASTAFile.h:74
String sequence
Definition: FASTAFile.h:65
FASTA entry type (identifier, description and sequence)
Definition: FASTAFile.h:61
String identifier
Definition: FASTAFile.h:63
This class serves for reading in FASTA files.
Definition: FASTAFile.h:48
String description
Definition: FASTAFile.h:64

OpenMS / TOPP release 2.0.0 Documentation generated on Tue Aug 25 2015 05:53:45 using doxygen 1.8.9.1