bpp-seq3  3.0.0
bpp::AbstractOProbabilisticAlignment Class Referenceabstract

Partial implementation of the OProbabilisticAlignment interface. More...

#include <Bpp/Seq/Io/AbstractOAlignment.h>

+ Inheritance diagram for bpp::AbstractOProbabilisticAlignment:
+ Collaboration diagram for bpp::AbstractOProbabilisticAlignment:

Public Member Functions

 AbstractOProbabilisticAlignment ()
 
virtual ~AbstractOProbabilisticAlignment ()
 
const std::string getDataType () const
 
virtual const std::string getFormatName () const=0
 
virtual const std::string getFormatDescription () const=0
 
OProbabilisticAlignment methods:
void writeAlignment (std::ostream &output, const ProbabilisticSiteContainerInterface &psc) const override=0
 Write a container to a stream. More...
 
void writeAlignment (const std::string &path, const ProbabilisticSiteContainerInterface &psc, bool overwrite=true) const override
 Write a container to a file. More...
 

Detailed Description

Partial implementation of the OProbabilisticAlignment interface.

Definition at line 50 of file AbstractOAlignment.h.

Constructor & Destructor Documentation

◆ AbstractOProbabilisticAlignment()

bpp::AbstractOProbabilisticAlignment::AbstractOProbabilisticAlignment ( )
inline

Definition at line 54 of file AbstractOAlignment.h.

◆ ~AbstractOProbabilisticAlignment()

virtual bpp::AbstractOProbabilisticAlignment::~AbstractOProbabilisticAlignment ( )
inlinevirtual

Definition at line 55 of file AbstractOAlignment.h.

Member Function Documentation

◆ getDataType()

const std::string bpp::IOProbabilisticSequence::getDataType ( ) const
inlinevirtualinherited

Implements bpp::IOFormat.

Reimplemented in bpp::Pasta.

Definition at line 44 of file IoSequence.h.

◆ writeAlignment() [1/2]

void bpp::AbstractOProbabilisticAlignment::writeAlignment ( const std::string &  path,
const ProbabilisticSiteContainerInterface sc,
bool  overwrite = true 
) const
inlineoverridevirtual

Write a container to a file.

Parameters
pathThe path to the file to write.
scThe container to write.
overwriteIf true the sequences are written at the beginning of the file instead of being appended. Any previous content will be lost.

Implements bpp::OProbabilisticAlignment.

Definition at line 65 of file AbstractOAlignment.h.

References writeAlignment().

◆ writeAlignment() [2/2]

void bpp::AbstractOProbabilisticAlignment::writeAlignment ( std::ostream &  output,
const ProbabilisticSiteContainerInterface sc 
) const
overridepure virtual

Write a container to a stream.

Parameters
outputThe output stream where to write.
scThe container to write.

Implements bpp::OProbabilisticAlignment.

Implemented in bpp::Pasta.

Referenced by writeAlignment().


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