General interface writers. More...

#include <Bpp/Io/IoParametrizable.h>

Inheritance diagram for bpp::OParametrizable:

Collaboration diagram for bpp::OParametrizable:

Public Member Functions
	OParametrizable ()

virtual	~OParametrizable ()

virtual void	write (const Parametrizable *parametrizable, OutputStream &out, std::vector< std::string > &writtenNames, bool printComma=false) const =0
	Write a Parametrizable to a stream. More...

virtual void	write (const ParameterAliasable *parametrizable, OutputStream &out, std::map< std::string, std::string > &globalAliases, const std::vector< std::string > &names, std::vector< std::string > &writtenNames, bool printLocalAliases=true, bool printComma=false) const =0
	Write a ParameterAliasable 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 69 of file IoParametrizable.h.

Constructor & Destructor Documentation

◆ OParametrizable()

bpp::OParametrizable::OParametrizable ( )

inline

Definition at line 73 of file IoParametrizable.h.

◆ ~OParametrizable()

virtual bpp::OParametrizable::~OParametrizable ( )

inlinevirtual

Definition at line 74 of file IoParametrizable.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IOParametrizable::getDataType ( ) const

inlinevirtualinherited

Get the type of data this format deals with.

Returns: The type of data.

Implements bpp::IOFormat.

Definition at line 63 of file IoParametrizable.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::BppOParametrizableFormat, and bpp::BppODiscreteDistributionFormat.

◆ 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::BppOParametrizableFormat, and bpp::BppODiscreteDistributionFormat.

◆ write() [1/2]

virtual void bpp::OParametrizable::write	(	const ParameterAliasable *	parametrizable,
		OutputStream &	out,
		std::map< std::string, std::string > &	globalAliases,
		const std::vector< std::string > &	names,
		std::vector< std::string > &	writtenNames,
		bool	printLocalAliases = `true`,
		bool	printComma = `false`
	)		const

pure virtual

Write a ParameterAliasable to a stream.

Parameters

parametrizable	A pointer to a Parametrizable object;
out	The output stream;
globalAliases	parameters linked to global alias;
names	the names of the parameters to be written;
writtenNames	is the vector of the written parameters so far [in, out];
printLocalAliases	boolean if local aliases should be written;
printComma	boolean if a comma should be written at the beginning of the description.

Implemented in bpp::BppOParametrizableFormat.

◆ write() [2/2]

virtual void bpp::OParametrizable::write	(	const Parametrizable *	parametrizable,
		OutputStream &	out,
		std::vector< std::string > &	writtenNames,
		bool	printComma = `false`
	)		const