bpp::BppOMultiTreeReaderFormat Class Reference

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

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

Inheritance diagram for bpp::BppOMultiTreeReaderFormat:

Collaboration diagram for bpp::BppOMultiTreeReaderFormat:

Public Member Functions
	BppOMultiTreeReaderFormat (int warningLevel)
virtual	~BppOMultiTreeReaderFormat ()
const std::string	getFormatName () const
const std::string	getFormatDescription () const
const std::string	getDataType () const
IMultiTree *	readIMultiTree (const std::string &description)
	Read a IMultiTree 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 BppOMultiTreeReaderFormat.h.

Constructor & Destructor Documentation

BppOMultiTreeReaderFormat()

bpp::BppOMultiTreeReaderFormat::BppOMultiTreeReaderFormat ( int  warningLevel )

inline

Definition at line 29 of file BppOMultiTreeReaderFormat.h.

~BppOMultiTreeReaderFormat()

virtual bpp::BppOMultiTreeReaderFormat::~BppOMultiTreeReaderFormat ( )

inlinevirtual

Definition at line 32 of file BppOMultiTreeReaderFormat.h.

Member Function Documentation

getDataType()

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

inlinevirtual

Implements bpp::IOFormat.

Definition at line 39 of file BppOMultiTreeReaderFormat.h.

getFormatDescription()

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

inlinevirtual

Implements bpp::IOFormat.

Definition at line 37 of file BppOMultiTreeReaderFormat.h.

getFormatName()

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

inlinevirtual

Implements bpp::IOFormat.

Definition at line 35 of file BppOMultiTreeReaderFormat.h.

getUnparsedArguments()

virtual const std::map< std::string, std::string > & bpp::BppOMultiTreeReaderFormat::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 BppOMultiTreeReaderFormat.h.

References unparsedArguments_.

readIMultiTree()

IMultiTree * BppOMultiTreeReaderFormat::readIMultiTree

(

const std::string &

description

)

Read a IMultiTree object from a string.

Parameters

description

A string describing the reader in the keyval syntax.

Returns

A new IMultiTree object according to options specified.

Exceptions

Exception

if an error occurred.

Definition at line 17 of file BppOMultiTreeReaderFormat.cpp.

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

Referenced by bpp::PhylogeneticsApplicationTools::getTrees().

Member Data Documentation

unparsedArguments_

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

private

Definition at line 25 of file BppOMultiTreeReaderFormat.h.

Referenced by getUnparsedArguments(), and readIMultiTree().

warningLevel_

int bpp::BppOMultiTreeReaderFormat::warningLevel_

private

Definition at line 26 of file BppOMultiTreeReaderFormat.h.

Referenced by readIMultiTree().

---

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

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