bpp-seq3  3.0.0
bpp::OProbabilisticSequence Class Referenceabstract

The OProbabilisticSequence interface. More...

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

+ Inheritance diagram for bpp::OProbabilisticSequence:
+ Collaboration diagram for bpp::OProbabilisticSequence:

Public Member Functions

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

Detailed Description

The OProbabilisticSequence interface.

This interface defines the basic methods for writing proba sequence to a file.

Definition at line 92 of file OSequence.h.

Constructor & Destructor Documentation

◆ OProbabilisticSequence()

bpp::OProbabilisticSequence::OProbabilisticSequence ( )
inline

Definition at line 96 of file OSequence.h.

◆ ~OProbabilisticSequence()

virtual bpp::OProbabilisticSequence::~OProbabilisticSequence ( )
inlinevirtual

Definition at line 97 of file OSequence.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]

virtual void bpp::OProbabilisticSequence::writeSequences ( const std::string &  path,
const ProbabilisticSequenceContainerInterface sc,
bool  overwrite 
) const
pure virtual

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.

Implemented in bpp::AbstractOProbabilisticSequence.

◆ writeSequences() [2/2]

virtual void bpp::OProbabilisticSequence::writeSequences ( std::ostream &  output,
const ProbabilisticSequenceContainerInterface sc 
) const
pure virtual

Write a container to a stream.

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

Implemented in bpp::AbstractOProbabilisticSequence.


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