General interface for distance matrix readers. More...

#include <Bpp/Io/IoDiscreteDistribution.h>

Inheritance diagram for bpp::IDiscreteDistribution:

Collaboration diagram for bpp::IDiscreteDistribution:

Public Member Functions
	IDiscreteDistribution ()

virtual	~IDiscreteDistribution ()

virtual std::unique_ptr< DiscreteDistributionInterface >	readDiscreteDistribution (const std::string &distrDescription, bool parseArguments=true)=0
	Read a discrete distribution from a string. More...

virtual const std::map< std::string, std::string > &	getUnparsedArguments () const =0

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 for distance matrix readers.

Definition at line 33 of file IoDiscreteDistribution.h.

Constructor & Destructor Documentation

◆ IDiscreteDistribution()

bpp::IDiscreteDistribution::IDiscreteDistribution ( )

inline

Definition at line 37 of file IoDiscreteDistribution.h.

◆ ~IDiscreteDistribution()

virtual bpp::IDiscreteDistribution::~IDiscreteDistribution ( )

inlinevirtual

Definition at line 38 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().

◆ getUnparsedArguments()

virtual const std::map<std::string, std::string>& bpp::IDiscreteDistribution::getUnparsedArguments ( ) const

pure virtual

Returns: The arguments and their unparsed values from the last call of the read function, if there are any.

Implemented in bpp::BppODiscreteDistributionFormat.

◆ readDiscreteDistribution()

virtual std::unique_ptr<DiscreteDistributionInterface> bpp::IDiscreteDistribution::readDiscreteDistribution	(	const std::string &	distrDescription,
		bool	parseArguments = `true`
	)

pure virtual

Read a discrete distribution from a string.

Parameters

distrDescription	A string describing the distribution in the format.
parseArguments	Attempt to parse function arguments. If not, only store them and use default values instead.

Returns: A new DiscreteDistribution object according to options specified.

Exceptions

Exception if an error occured.