bpp-core3  3.0.0
bpp::IOFormat Class Referenceabstract

The IOFormat interface. More...

#include <Bpp/Io/IoFormat.h>

+ Inheritance diagram for bpp::IOFormat:

Public Member Functions

 IOFormat ()
 
virtual ~IOFormat ()
 
virtual const std::string getDataType () const =0
 Get the type of data this format deals with. More...
 
virtual const std::string getFormatName () const =0
 Get the name of the file format. More...
 
virtual const std::string getFormatDescription () const =0
 Get a description of the file format. More...
 

Detailed Description

The IOFormat interface.

This is the most basal class of any format I/O implementation.

Definition at line 21 of file IoFormat.h.

Constructor & Destructor Documentation

◆ IOFormat()

bpp::IOFormat::IOFormat ( )
inline

Definition at line 24 of file IoFormat.h.

◆ ~IOFormat()

virtual bpp::IOFormat::~IOFormat ( )
inlinevirtual

Definition at line 25 of file IoFormat.h.

References getDataType(), getFormatDescription(), and getFormatName().

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IOFormat::getDataType ( ) const
pure virtual

Get the type of data this format deals with.

Returns
The type of data.

Implemented in bpp::IoDiscreteDistribution, and bpp::IOParametrizable.

Referenced by ~IOFormat().

◆ getFormatDescription()

virtual const std::string bpp::IOFormat::getFormatDescription ( ) const
pure virtual

Get a description of the file format.

Returns
A description of the format implemented.

Implemented in bpp::BppODiscreteDistributionFormat, and bpp::BppOParametrizableFormat.

Referenced by ~IOFormat().

◆ getFormatName()

virtual const std::string bpp::IOFormat::getFormatName ( ) const
pure virtual

Get the name of the file format.

Returns
The name of the format implemented.

Implemented in bpp::BppODiscreteDistributionFormat, and bpp::BppOParametrizableFormat.

Referenced by ~IOFormat().


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