bpp-core3  3.0.0
IoFormat.h
Go to the documentation of this file.
1 //
2 // File: IoFormat.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2005-10-07 00:00:00
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
10 
11  This software is a computer program whose purpose is to provide utilitary
12  classes. This file belongs to the Bio++ Project.
13 
14  This software is governed by the CeCILL license under French law and
15  abiding by the rules of distribution of free software. You can use,
16  modify and/ or redistribute the software under the terms of the CeCILL
17  license as circulated by CEA, CNRS and INRIA at the following URL
18  "http://www.cecill.info".
19 
20  As a counterpart to the access to the source code and rights to copy,
21  modify and redistribute granted by the license, users are provided only
22  with a limited warranty and the software's author, the holder of the
23  economic rights, and the successive licensors have only limited
24  liability.
25 
26  In this respect, the user's attention is drawn to the risks associated
27  with loading, using, modifying and/or developing or reproducing the
28  software by the user in light of its specific status of free software,
29  that may mean that it is complicated to manipulate, and that also
30  therefore means that it is reserved for developers and experienced
31  professionals having in-depth computer knowledge. Users are therefore
32  encouraged to load and test the software's suitability as regards their
33  requirements in conditions enabling the security of their systems and/or
34  data to be ensured and, more generally, to use and operate it in the
35  same conditions as regards security.
36 
37  The fact that you are presently reading this means that you have had
38  knowledge of the CeCILL license and that you accept its terms.
39 */
40 
41 #ifndef BPP_IO_IOFORMAT_H
42 #define BPP_IO_IOFORMAT_H
43 
44 
45 #include "../Exceptions.h"
46 
47 // From STL:
48 #include <string>
49 
50 namespace bpp
51 {
57 class IOFormat
58 {
59 public:
60  IOFormat() {}
61  virtual ~IOFormat() {}
62 
63 public:
69  virtual const std::string getDataType() const = 0;
70 
76  virtual const std::string getFormatName() const = 0;
77 
83  virtual const std::string getFormatDescription() const = 0;
84 };
85 } // end of namespace bpp.
86 #endif // BPP_IO_IOFORMAT_H
The IOFormat interface.
Definition: IoFormat.h:58
virtual const std::string getFormatDescription() const =0
Get a description of the file format.
virtual ~IOFormat()
Definition: IoFormat.h:61
virtual const std::string getDataType() const =0
Get the type of data this format deals with.
virtual const std::string getFormatName() const =0
Get the name of the file format.