bpp::BppOMultiTreeWriterFormat Class Reference

Tree I/O in BppO format. More...

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

Inheritance diagram for bpp::BppOMultiTreeWriterFormat:

Collaboration diagram for bpp::BppOMultiTreeWriterFormat:

Public Member Functions
	BppOMultiTreeWriterFormat (int warningLevel)
virtual	~BppOMultiTreeWriterFormat ()
const std::string	getFormatName () const
const std::string	getFormatDescription () const
const std::string	getDataType () const
OMultiTree *	readOMultiTree (const std::string &description)
	Read a OMultiTree object from a string. More...
virtual const std::map< std::string, std::string > &	getUnparsedArguments () const

Private Attributes
std::map< std::string, std::string >	unparsedArguments_
int	warningLevel_

Detailed Description

Tree I/O in BppO format.

Creates a new IMultiTree object according to distribution description syntax (see the Bio++ Program Suite manual for a detailed description of this syntax).

Definition at line 21 of file BppOMultiTreeWriterFormat.h.

Constructor & Destructor Documentation

BppOMultiTreeWriterFormat()

bpp::BppOMultiTreeWriterFormat::BppOMultiTreeWriterFormat ( int  warningLevel )

inline

Definition at line 29 of file BppOMultiTreeWriterFormat.h.

~BppOMultiTreeWriterFormat()

virtual bpp::BppOMultiTreeWriterFormat::~BppOMultiTreeWriterFormat ( )

inlinevirtual

Definition at line 32 of file BppOMultiTreeWriterFormat.h.

Member Function Documentation

getDataType()

const std::string bpp::BppOMultiTreeWriterFormat::getDataType ( ) const

inlinevirtual

Implements bpp::IOFormat.

Definition at line 39 of file BppOMultiTreeWriterFormat.h.

getFormatDescription()

const std::string bpp::BppOMultiTreeWriterFormat::getFormatDescription ( ) const

inlinevirtual

Implements bpp::IOFormat.

Definition at line 37 of file BppOMultiTreeWriterFormat.h.

getFormatName()

const std::string bpp::BppOMultiTreeWriterFormat::getFormatName ( ) const

inlinevirtual

Implements bpp::IOFormat.

Definition at line 35 of file BppOMultiTreeWriterFormat.h.

getUnparsedArguments()

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

inlinevirtual

Returns

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

Definition at line 53 of file BppOMultiTreeWriterFormat.h.

References unparsedArguments_.

readOMultiTree()

OMultiTree * BppOMultiTreeWriterFormat::readOMultiTree

(

const std::string &

description

)

Read a OMultiTree object from a string.

Parameters

description

A string describing the reader in the keyval syntax.

Returns

A new OMultiTree object according to options specified.

Exceptions

Exception

if an error occurred.

Definition at line 17 of file BppOMultiTreeWriterFormat.cpp.

References bpp::ApplicationTools::getBooleanParameter(), bpp::KeyvalTools::parseProcedure(), unparsedArguments_, and warningLevel_.

Member Data Documentation

unparsedArguments_

std::map<std::string, std::string> bpp::BppOMultiTreeWriterFormat::unparsedArguments_

private

Definition at line 25 of file BppOMultiTreeWriterFormat.h.

Referenced by getUnparsedArguments(), and readOMultiTree().

warningLevel_

int bpp::BppOMultiTreeWriterFormat::warningLevel_

private

Definition at line 26 of file BppOMultiTreeWriterFormat.h.

Referenced by readOMultiTree().

---

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

• Bpp/Phyl/Io/BppOMultiTreeWriterFormat.h
• Bpp/Phyl/Io/BppOMultiTreeWriterFormat.cpp