bpp-phyl3  3.0.0
bpp::OSubstitutionModel Class Referenceabstract

General interface for distance matrix writers. More...

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

+ Inheritance diagram for bpp::OSubstitutionModel:
+ Collaboration diagram for bpp::OSubstitutionModel:

Public Member Functions

 OSubstitutionModel ()
 
virtual ~OSubstitutionModel ()
 
virtual void write (const BranchModelInterface &model, OutputStream &out, std::map< std::string, std::string > &globalAliases, std::vector< std::string > &writtenNames) const =0
 Write a substitution model to a stream. More...
 
virtual const std::string getDataType () const
 
virtual const std::string getFormatName () const=0
 
virtual const std::string getFormatDescription () const=0
 

Detailed Description

General interface for distance matrix writers.

Definition at line 77 of file IoSubstitutionModel.h.

Constructor & Destructor Documentation

◆ OSubstitutionModel()

bpp::OSubstitutionModel::OSubstitutionModel ( )
inline

Definition at line 81 of file IoSubstitutionModel.h.

◆ ~OSubstitutionModel()

virtual bpp::OSubstitutionModel::~OSubstitutionModel ( )
inlinevirtual

Definition at line 82 of file IoSubstitutionModel.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IoSubstitutionModel::getDataType ( ) const
inlinevirtualinherited

Implements bpp::IOFormat.

Definition at line 35 of file IoSubstitutionModel.h.

◆ write()

virtual void bpp::OSubstitutionModel::write ( const BranchModelInterface model,
OutputStream out,
std::map< std::string, std::string > &  globalAliases,
std::vector< std::string > &  writtenNames 
) const
pure virtual

Write a substitution model to a stream.

Parameters
modelA substitution model object;
outThe output stream;
globalAliasesparameters linked to global alias.
writtenNamesis the vector of the written parameters so far [in, out];
Exceptions
Exceptionif an error occurred.

Implemented in bpp::BppOSubstitutionModelFormat.


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