The IAlignment interface.
More...
#include <Bpp/Seq/Io/ISequence.h>
The IAlignment interface.
This interface defines the basic methods for reading aligned sequences from a file.
Definition at line 99 of file ISequence.h.
◆ IAlignment()
bpp::IAlignment::IAlignment |
( |
| ) |
|
|
inline |
◆ ~IAlignment()
virtual bpp::IAlignment::~IAlignment |
( |
| ) |
|
|
inlinevirtual |
◆ getDataType()
const std::string bpp::IOSequence::getDataType |
( |
| ) |
const |
|
inlineinherited |
◆ readAlignment() [1/2]
virtual SiteContainer* bpp::IAlignment::readAlignment |
( |
std::istream & |
input, |
|
|
const Alphabet * |
alpha |
|
) |
| const |
throw | ( | Exception |
| ) | | |
|
pure virtual |
Create a new container from a stream.
- Parameters
-
input | The input stream to read. |
alpha | The alphabet to be associated to the container. |
- Returns
- A new SiteContainer object.
- Exceptions
-
Exception | If the file is not in the specified format. |
Implemented in bpp::AbstractIAlignment.
◆ readAlignment() [2/2]
virtual SiteContainer* bpp::IAlignment::readAlignment |
( |
const std::string & |
path, |
|
|
const Alphabet * |
alpha |
|
) |
| const |
throw | ( | Exception |
| ) | | |
|
pure virtual |
Create a new container from a file.
- Parameters
-
path | The path to the file to read. |
alpha | The alphabet to be associated to the container. |
- Returns
- A new SiteContainer object.
- Exceptions
-
Exception | If the file is not in the specified format. |
Implemented in bpp::AbstractIAlignment.
The documentation for this class was generated from the following file: