bpp-core3  3.0.0
bpp::ODiscreteDistribution Class Referenceabstract

General interface writers. More...

#include <Bpp/Io/IoDiscreteDistribution.h>

+ Inheritance diagram for bpp::ODiscreteDistribution:
+ Collaboration diagram for bpp::ODiscreteDistribution:

Public Member Functions

 ODiscreteDistribution ()
 
virtual ~ODiscreteDistribution ()
 
virtual void writeDiscreteDistribution (const DiscreteDistributionInterface &dist, OutputStream &out, std::map< std::string, std::string > &globalAliases, std::vector< std::string > &writtenNames) const =0
 Write a discrete distribution to a stream. More...
 
virtual const std::string getDataType () const
 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

General interface writers.

Definition at line 62 of file IoDiscreteDistribution.h.

Constructor & Destructor Documentation

◆ ODiscreteDistribution()

bpp::ODiscreteDistribution::ODiscreteDistribution ( )
inline

Definition at line 66 of file IoDiscreteDistribution.h.

◆ ~ODiscreteDistribution()

virtual bpp::ODiscreteDistribution::~ODiscreteDistribution ( )
inlinevirtual

Definition at line 67 of file IoDiscreteDistribution.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IoDiscreteDistribution::getDataType ( ) const
inlinevirtualinherited

Get the type of data this format deals with.

Returns
The type of data.

Implements bpp::IOFormat.

Definition at line 27 of file IoDiscreteDistribution.h.

◆ getFormatDescription()

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

Get a description of the file format.

Returns
A description of the format implemented.

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

Referenced by bpp::IOFormat::~IOFormat().

◆ getFormatName()

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

Get the name of the file format.

Returns
The name of the format implemented.

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

Referenced by bpp::IOFormat::~IOFormat().

◆ writeDiscreteDistribution()

virtual void bpp::ODiscreteDistribution::writeDiscreteDistribution ( const DiscreteDistributionInterface dist,
OutputStream out,
std::map< std::string, std::string > &  globalAliases,
std::vector< std::string > &  writtenNames 
) const
pure virtual

Write a discrete distribution to a stream.

Parameters
distA discrete distribution object;
outThe output stream;
globalAliasesparameters linked to global alias.
writtenNamesis the vector of the written parameters so far [in, out];
Exceptions
Exceptionif an error occured.

Implemented in bpp::BppODiscreteDistributionFormat.


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