2
// File IODistanceMatrixFactory.h
3
// Created by: Julien Dutheil
4
// Created on: Tue 18/04/06 10:24
8
Copyright or © or Copr. CNRS, (November 17, 2004)
10
This software is a computer program whose purpose is to provide classes
11
for sequences analysis.
13
This software is governed by the CeCILL license under French law and
14
abiding by the rules of distribution of free software. You can use,
15
modify and/ or redistribute the software under the terms of the CeCILL
16
license as circulated by CEA, CNRS and INRIA at the following URL
17
"http://www.cecill.info".
19
As a counterpart to the access to the source code and rights to copy,
20
modify and redistribute granted by the license, users are provided only
21
with a limited warranty and the software's author, the holder of the
22
economic rights, and the successive licensors have only limited
25
In this respect, the user's attention is drawn to the risks associated
26
with loading, using, modifying and/or developing or reproducing the
27
software by the user in light of its specific status of free software,
28
that may mean that it is complicated to manipulate, and that also
29
therefore means that it is reserved for developers and experienced
30
professionals having in-depth computer knowledge. Users are therefore
31
encouraged to load and test the software's suitability as regards their
32
requirements in conditions enabling the security of their systems and/or
33
data to be ensured and, more generally, to use and operate it in the
34
same conditions as regards security.
36
The fact that you are presently reading this means that you have had
37
knowledge of the CeCILL license and that you accept its terms.
40
#ifndef _IODISTANCEMATRIXFACTORY_H_
41
#define _IODISTANCEMATRIXFACTORY_H_
43
#include "../Distance.all"
44
#include "IoDistanceMatrix.h"
45
#include <Bpp/Exceptions.h>
54
* @brief Utilitary class for creating distance matrix readers and writers.
56
* @see IOSequenceFactory
59
class IODistanceMatrixFactory
62
static const std::string PHYLIP_FORMAT;
67
* @brief Creates a new factory object.
71
* IDistanceMatrix * matReader = IODistanceMatrixFactory().createReader(IODistanceMatrixFactory::PHYLIP);
72
* DistanceMatrix * matrix = matReader->read("file.ph");
76
IODistanceMatrixFactory() {}
77
virtual ~IODistanceMatrixFactory() {}
80
* @brief Get a new dynamically created IDistanceMatrix object.
82
* @param format The input file format.
83
* @return A pointer toward a new IDistanceMatrix object.
84
* @throw Exception If the format name do not match any available format.
86
virtual IDistanceMatrix* createReader(const std::string& format) throw (Exception);
89
* @brief Get a new dynamically created ODistanceMatrix object.
91
* @param format The output file format.
92
* @return A pointer toward a new ODistanceMatrix object.
93
* @throw Exception If the format name do not match any available format.
95
virtual ODistanceMatrix * createWriter(const std::string& format) throw (Exception);
98
} //end of namespace bpp.
100
#endif //_IODISTANCEMATRIXFACTORY_H_