bpp-seq3  3.0.0
bpp::AbstractOProbabilisticSequence Class Referenceabstract

Partial implementation of the OProbabilisticSequence interface. More...

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

+ Inheritance diagram for bpp::AbstractOProbabilisticSequence:
+ Collaboration diagram for bpp::AbstractOProbabilisticSequence:

Public Member Functions

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

Detailed Description

Partial implementation of the OProbabilisticSequence interface.

Definition at line 88 of file AbstractOSequence.h.

Constructor & Destructor Documentation

◆ AbstractOProbabilisticSequence()

bpp::AbstractOProbabilisticSequence::AbstractOProbabilisticSequence ( )
inline

Definition at line 92 of file AbstractOSequence.h.

◆ ~AbstractOProbabilisticSequence()

virtual bpp::AbstractOProbabilisticSequence::~AbstractOProbabilisticSequence ( )
inlinevirtual

Definition at line 93 of file AbstractOSequence.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.

◆ writeSequences() [1/2]

void bpp::AbstractOProbabilisticSequence::writeSequences ( const std::string &  path,
const ProbabilisticSequenceContainerInterface 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::OProbabilisticSequence.

Definition at line 103 of file AbstractOSequence.h.

References writeSequences().

◆ writeSequences() [2/2]

void bpp::AbstractOProbabilisticSequence::writeSequences ( std::ostream &  output,
const ProbabilisticSequenceContainerInterface sc 
) const
overridepure virtual

Write a container to a stream.

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

Implements bpp::OProbabilisticSequence.

Referenced by bpp::AbstractOProbabilisticSequence2::writeAlignment(), and writeSequences().


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