~ubuntu-branches/ubuntu/trusty/libbpp-popgen/trusty

« back to all changes in this revision

Viewing changes to src/Bpp/PopGen/IDataSet.h

  • Committer: Package Import Robot
  • Author(s): Julien Dutheil
  • Date: 2013-03-07 10:51:00 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20130307105100-7ij3w7iyab9t2mbt
Tags: 2.1.0-1
Bug fixed and warnings removed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
   for population genetics analysis.
12
12
 
13
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, 
 
14
   abiding by the rules of distribution of free software.  You can  use,
15
15
   modify and/ or redistribute the software under the terms of the CeCILL
16
16
   license as circulated by CEA, CNRS and INRIA at the following URL
17
 
   "http://www.cecill.info". 
 
17
   "http://www.cecill.info".
18
18
 
19
19
   As a counterpart to the access to the source code and  rights to copy,
20
20
   modify and redistribute granted by the license, users are provided only
21
21
   with a limited warranty  and the software's author,  the holder of the
22
22
   economic rights,  and the successive licensors  have only  limited
23
 
   liability. 
 
23
   liability.
24
24
 
25
25
   In this respect, the user's attention is drawn to the risks associated
26
26
   with loading,  using,  modifying and/or developing or reproducing the
29
29
   therefore means  that it is reserved for developers  and  experienced
30
30
   professionals having in-depth computer knowledge. Users are therefore
31
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. 
 
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
35
 
36
36
   The fact that you are presently reading this means that you have had
37
37
   knowledge of the CeCILL license and that you accept its terms.
38
 
   */
 
38
 */
39
39
 
40
40
#ifndef _IDATASET_H_
41
41
#define _IDATASET_H_
46
46
 
47
47
namespace bpp
48
48
{
49
 
 
50
 
  /**
51
 
   * @brief The IDataSet interface.
52
 
   *
53
 
   * @author Sylvain Gaillard
54
 
   */
55
 
  class IDataSet:
56
 
    public virtual IODataSet
57
 
  {
58
 
    public: // Class destructor
59
 
      virtual ~IDataSet() {}
60
 
 
61
 
    public:
62
 
      /**
63
 
       * @brief Read a DataSet on istream.
64
 
       */
65
 
      virtual void read(std::istream & is, DataSet & data_set) throw (Exception) = 0;
66
 
 
67
 
      /**
68
 
       * @brief Read a DataSet from a text file.
69
 
       */
70
 
      virtual void read(const std::string & path, DataSet & data_set) throw (Exception) = 0;
71
 
 
72
 
      /**
73
 
       * @brief Read istream and return a DataSet.
74
 
       */
75
 
      virtual DataSet * read(std::istream & is) throw (Exception) = 0;
76
 
 
77
 
      /**
78
 
       * @brief Read a text file and return a DataSet.
79
 
       */
80
 
      virtual DataSet * read(const std::string & path) throw (Exception) = 0;
81
 
  };
82
 
 
83
 
} //end of namespace bpp;
 
49
/**
 
50
 * @brief The IDataSet interface.
 
51
 *
 
52
 * @author Sylvain Gaillard
 
53
 */
 
54
class IDataSet :
 
55
  public virtual IODataSet
 
56
{
 
57
public:
 
58
  // Class destructor
 
59
  virtual ~IDataSet() {}
 
60
 
 
61
public:
 
62
  /**
 
63
   * @brief Read a DataSet on istream.
 
64
   */
 
65
  virtual void read(std::istream& is, DataSet& data_set) throw (Exception) = 0;
 
66
 
 
67
  /**
 
68
   * @brief Read a DataSet from a text file.
 
69
   */
 
70
  virtual void read(const std::string& path, DataSet& data_set) throw (Exception) = 0;
 
71
 
 
72
  /**
 
73
   * @brief Read istream and return a DataSet.
 
74
   */
 
75
  virtual DataSet* read(std::istream& is) throw (Exception) = 0;
 
76
 
 
77
  /**
 
78
   * @brief Read a text file and return a DataSet.
 
79
   */
 
80
  virtual DataSet* read(const std::string& path) throw (Exception) = 0;
 
81
};
 
82
} // end of namespace bpp;
84
83
 
85
84
#endif // _IDATASET_H_
86
85