2
// File: BppOSequenceReaderFormat.h
3
// Created by: Julien Dutheil
4
// Created on: Friday September 14th, 14:08
8
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
10
This software is a computer program whose purpose is to provide classes
11
for phylogenetic data 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 _BPPOSEQUENCEREADERFORMAT_H_
41
#define _BPPOSEQUENCEREADERFORMAT_H_
43
#include "IoSequenceFactory.h"
49
* @brief Sequence I/O in BppO format.
51
* Creates a new ISequence object according to
52
* distribution description syntax (see the Bio++ Program Suite
53
* manual for a detailed description of this syntax).
56
class BppOSequenceReaderFormat:
57
public virtual IOFormat
61
std::map<std::string, std::string> unparsedArguments_;
64
BppOSequenceReaderFormat(bool verbose = true):
66
unparsedArguments_() {}
67
virtual ~BppOSequenceReaderFormat() {}
70
const std::string getFormatName() const { return "BppO"; }
72
const std::string getFormatDescription() const { return "Bpp Options format."; }
74
const std::string getDataType() const { return "Sequence reader"; }
77
* @brief Read a ISequence object from a string.
79
* @param description A string describing the reader in the keyval syntax.
80
* @return A new ISequence object according to options specified.
81
* @throw Exception if an error occured.
83
ISequence* read(const std::string& description) throw (Exception);
86
* @return The arguments and their unparsed values from the last call of the read function, if there are any.
88
virtual const std::map<std::string, std::string>& getUnparsedArguments() const { return unparsedArguments_; }
92
} //end of namespace bpp.
94
#endif //_BPPOSEQUENCEREADERFORMAT_H_