bpp::IDataSet Class Reference

The IDataSet interface. More...

#include <Bpp/PopGen/DataSet/Io/IDataSet.h>

Inheritance diagram for bpp::IDataSet:

Collaboration diagram for bpp::IDataSet:

Public Member Functions
virtual	~IDataSet ()
virtual void	read (std::istream &is, DataSet &data_set)=0
	Read a DataSet on istream. More...
virtual void	read (const std::string &path, DataSet &data_set)=0
	Read a DataSet from a text file. More...
virtual DataSet *	read (std::istream &is)=0
	Read istream and return a DataSet. More...
virtual DataSet *	read (const std::string &path)=0
	Read a text file and return a DataSet. More...
virtual const std::string	getFormatName () const=0
virtual const std::string	getFormatDescription () const=0

Private Member Functions
The IOFormat interface.
const std::string	getDataType () const

Detailed Description

The IDataSet interface.

Author

Sylvain Gaillard

Definition at line 19 of file IDataSet.h.

Constructor & Destructor Documentation

~IDataSet()

virtual bpp::IDataSet::~IDataSet ( )

inlinevirtual

Definition at line 24 of file IDataSet.h.

Member Function Documentation

getDataType()

const std::string bpp::IODataSet::getDataType ( ) const

inlineprivatevirtualinherited

Implements bpp::IOFormat.

Definition at line 33 of file IODataSet.h.

read() [1/4]

virtual DataSet* bpp::IDataSet::read ( const std::string &  path )

pure virtual

Read a text file and return a DataSet.

Implemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, bpp::GeneMapperCsvExport, and bpp::AbstractIDataSet.

read() [2/4]

virtual void bpp::IDataSet::read ( const std::string &  path, DataSet &  data_set  )

pure virtual

Read a DataSet from a text file.

Implemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, bpp::GeneMapperCsvExport, and bpp::AbstractIDataSet.

read() [3/4]

virtual DataSet* bpp::IDataSet::read ( std::istream &  is )

pure virtual

Read istream and return a DataSet.

Implemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, bpp::GeneMapperCsvExport, and bpp::AbstractIDataSet.

read() [4/4]

virtual void bpp::IDataSet::read ( std::istream &  is, DataSet &  data_set  )

pure virtual

Read a DataSet on istream.

Implemented in bpp::AbstractIDataSet, bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, and bpp::GeneMapperCsvExport.

---

The documentation for this class was generated from the following file:

• Bpp/PopGen/DataSet/Io/IDataSet.h