bpp-popgen  3.0.0
bpp::AbstractIDataSet Class Referenceabstract

Partial implementation of the DataSet Input interface. More...

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

+ Inheritance diagram for bpp::AbstractIDataSet:
+ Collaboration diagram for bpp::AbstractIDataSet:

Public Member Functions

virtual ~AbstractIDataSet ()
 
virtual const std::string getFormatName () const=0
 
virtual const std::string getFormatDescription () const=0
 
The IDataSet interface.
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)
 Read a DataSet from a text file. More...
 
virtual DataSetread (std::istream &is)
 Read istream and return a DataSet. More...
 
virtual DataSetread (const std::string &path)
 Read a text file and return a DataSet. More...
 

Private Member Functions

The IOFormat interface.
const std::string getDataType () const
 

Detailed Description

Partial implementation of the DataSet Input interface.

Author
Sylvain Gaillard

Definition at line 55 of file AbstractIDataSet.h.

Constructor & Destructor Documentation

◆ ~AbstractIDataSet()

AbstractIDataSet::~AbstractIDataSet ( )
virtual

Definition at line 50 of file AbstractIDataSet.cpp.

Member Function Documentation

◆ getDataType()

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

Implements bpp::IOFormat.

Definition at line 67 of file IODataSet.h.

◆ read() [1/4]

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

Read a text file and return a DataSet.

Implements bpp::IDataSet.

Reimplemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, and bpp::GeneMapperCsvExport.

Definition at line 66 of file AbstractIDataSet.cpp.

◆ read() [2/4]

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

Read a DataSet from a text file.

Implements bpp::IDataSet.

Reimplemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, and bpp::GeneMapperCsvExport.

Definition at line 52 of file AbstractIDataSet.cpp.

◆ read() [3/4]

DataSet * AbstractIDataSet::read ( std::istream &  is)
virtual

Read istream and return a DataSet.

Implements bpp::IDataSet.

Reimplemented in bpp::PopgenlibIO, bpp::Genetix, bpp::Genepop, and bpp::GeneMapperCsvExport.

Definition at line 59 of file AbstractIDataSet.cpp.

◆ read() [4/4]

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

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