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