Utilitary class for creating frequencies set readers and writers. More...

#include <Bpp/Phyl/Io/IoFrequenciesSetFactory.h>

Collaboration diagram for bpp::IOFrequenciesSetFactory:

Public Member Functions
	IOFrequenciesSetFactory ()
	Creates a new factory object. More...

virtual	~IOFrequenciesSetFactory ()

virtual IFrequenciesSet *	createReader (const std::string &format) throw (Exception)
	Get a new dynamically created IFrequenciesSet object. More...

virtual OFrequenciesSet *	createWriter (const std::string &format) throw (Exception)
	Get a new dynamically created OFrequenciesSet object. More...

Static Public Attributes
static const std::string	BPPO_FORMAT = "Bpp0"

Detailed Description

Utilitary class for creating frequencies set readers and writers.

See also: IOSequenceFactory; IOTreeFactory

Definition at line 59 of file IoFrequenciesSetFactory.h.

Constructor & Destructor Documentation

◆ IOFrequenciesSetFactory()

bpp::IOFrequenciesSetFactory::IOFrequenciesSetFactory ( )

inline

Creates a new factory object.

Example:

IFrequenciesSet * freqReader = IOFrequenciesSetFactory().createReader(IOFrequenciesSetFactory::BPP_FORMAT);
FrequenciesSet * freqset = freqReader->read(...);
delete freqReader;

Definition at line 76 of file IoFrequenciesSetFactory.h.

◆ ~IOFrequenciesSetFactory()

virtual bpp::IOFrequenciesSetFactory::~IOFrequenciesSetFactory ( )

inlinevirtual

Definition at line 77 of file IoFrequenciesSetFactory.h.

Member Function Documentation

◆ createReader()

IFrequenciesSet * IOFrequenciesSetFactory::createReader	(	const std::string &	format	)
throw	(	Exception
	)

virtual

Get a new dynamically created IFrequenciesSet object.

Parameters

format The input file format.

Returns: A pointer toward a new IFrequenciesSet object.

Exceptions

Exception If the format name do not match any available format.

Definition at line 46 of file IoFrequenciesSetFactory.cpp.

References bpp::BppOFrequenciesSetFormat::ALL.

◆ createWriter()

OFrequenciesSet * IOFrequenciesSetFactory::createWriter	(	const std::string &	format	)
throw	(	Exception
	)

virtual

Get a new dynamically created OFrequenciesSet object.

Parameters

format The output file format.

Returns: A pointer toward a new OFrequenciesSet object.

Exceptions

Exception If the format name do not match any available format.

Definition at line 52 of file IoFrequenciesSetFactory.cpp.

References bpp::BppOFrequenciesSetFormat::ALL.

Member Data Documentation

◆ BPPO_FORMAT

const std::string IOFrequenciesSetFactory::BPPO_FORMAT = "Bpp0"

static

Definition at line 62 of file IoFrequenciesSetFactory.h.

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

Bpp/Phyl/Io/IoFrequenciesSetFactory.h
Bpp/Phyl/Io/IoFrequenciesSetFactory.cpp

Public Member Functions

Static Public Attributes