Utilitary class for creating distance matrix readers and writers.
More...
#include <Bpp/Phyl/Io/IoDistanceMatrixFactory.h>
Utilitary class for creating distance matrix readers and writers.
- See also
- IOSequenceFactory
-
IOTreeFactory
Definition at line 59 of file IoDistanceMatrixFactory.h.
◆ IODistanceMatrixFactory()
bpp::IODistanceMatrixFactory::IODistanceMatrixFactory |
( |
| ) |
|
|
inline |
Creates a new factory object.
Example:
DistanceMatrix * matrix = matReader->read("file.ph");
delete matReader;
Definition at line 76 of file IoDistanceMatrixFactory.h.
◆ ~IODistanceMatrixFactory()
virtual bpp::IODistanceMatrixFactory::~IODistanceMatrixFactory |
( |
| ) |
|
|
inlinevirtual |
◆ createReader()
IDistanceMatrix * IODistanceMatrixFactory::createReader |
( |
const std::string & |
format, |
|
|
bool |
extended = false |
|
) |
| |
throw | ( | Exception |
| ) | | |
|
virtual |
Get a new dynamically created IDistanceMatrix object.
- Parameters
-
format | The input file format, and whether names should be only less than 10 characters, or not (false=10 characters max). |
extended | format (default false). |
- Returns
- A pointer toward a new IDistanceMatrix object.
- Exceptions
-
Exception | If the format name do not match any available format. |
Definition at line 47 of file IoDistanceMatrixFactory.cpp.
◆ createWriter()
ODistanceMatrix * IODistanceMatrixFactory::createWriter |
( |
const std::string & |
format, |
|
|
bool |
extended = false |
|
) |
| |
throw | ( | Exception |
| ) | | |
|
virtual |
Get a new dynamically created ODistanceMatrix object.
- Parameters
-
format | The output file format, and whether names should be only less than 10 characters, or not (false=10 characters max). |
extended | format (default false). |
- Returns
- A pointer toward a new ODistanceMatrix object.
- Exceptions
-
Exception | If the format name do not match any available format. |
Definition at line 53 of file IoDistanceMatrixFactory.cpp.
◆ PHYLIP_FORMAT
const std::string IODistanceMatrixFactory::PHYLIP_FORMAT = "Phylip" |
|
static |
The documentation for this class was generated from the following files: