OpenStructure
clustal_io_handler.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of the OpenStructure project <www.openstructure.org>
3 //
4 // Copyright (C) 2008-2020 by the OpenStructure authors
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License as published by the Free
8 // Software Foundation; either version 3.0 of the License, or (at your option)
9 // any later version.
10 // This library is distributed in the hope that it will be useful, but WITHOUT
11 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 // details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library; if not, write to the Free Software Foundation, Inc.,
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //------------------------------------------------------------------------------
19 #ifndef OST_IO_CLUSTAL_HANDLER_HH
20 #define OST_IO_CLUSTAL_HANDLER_HH
21 /*
22  Author: Marco Biasini
23  */
24 #include <ost/io/module_config.hh>
25 #include "sequence_io_handler.hh"
26 
27 namespace ost { namespace io {
28 
30 public:
31  virtual void Import(seq::SequenceList& ali,
32  const boost::filesystem::path& loc);
33 
34  virtual void Export(const seq::ConstSequenceList& ent,
35  const boost::filesystem::path& loc) const;
36 
37  virtual void Import(seq::SequenceList& ent,
38  std::istream& instream);
39 
40  virtual void Export(const seq::ConstSequenceList& ent,
41  std::ostream& ostream) const;
42 
43  static bool ProvidesImport(const boost::filesystem::path& loc,
44  const String& format="auto");
45  static bool ProvidesExport(const boost::filesystem::path& loc,
46  const String& format="auto");
47  static String GetFormatName() { return String("Clustal"); }
48  static String GetFormatDescription() { return String("Format used by the ClustalW2 software package"); }
49 
50 };
51 
53 
54 }}
55 
56 #endif
static bool ProvidesImport(const boost::filesystem::path &loc, const String &format="auto")
virtual void Export(const seq::ConstSequenceList &ent, std::ostream &ostream) const
virtual void Import(seq::SequenceList &ent, std::istream &instream)
static bool ProvidesExport(const boost::filesystem::path &loc, const String &format="auto")
virtual void Import(seq::SequenceList &ali, const boost::filesystem::path &loc)
virtual void Export(const seq::ConstSequenceList &ent, const boost::filesystem::path &loc) const
static String GetFormatDescription()
pure abstract base class for entity io handlers
list of immutable sequences.
list of sequences.
#define DLLEXPORT_OST_IO
std::string String
Definition: base.hh:54
SequenceIOHandlerFactory< ClustalIOHandler > ClustalIOHandlerFactory
Definition: base.dox:1