/usr/include/Bpp/Io/BppOParametrizableFormat.h is in libbpp-core-dev 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | //
// File: Bpp0ParametrizableFormat.h
// Created by: Laurent Guéguen
// Created on: lundi 3 septembre 2012, à 15h 30
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
This software is a computer program whose purpose is to provide classes
for phylogenetic data analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _BPPOPARAMETRIZABLEFORMAT_H_
#define _BPPOPARAMETRIZABLEFORMAT_H_
#include "IoParametrizable.h"
namespace bpp
{
/**
* @brief Parametrizable output in BppO format.
*
* Writes a new parametrizable object according to BppO description
* syntax (see the Bio++ Progam Suite manual for a detailed
* description of this syntax).
*
*/
class BppOParametrizableFormat:
public OParametrizable
{
public:
BppOParametrizableFormat() {}
virtual ~BppOParametrizableFormat() {}
public:
const std::string getFormatName() const { return "BppO"; }
const std::string getFormatDescription() const { return "Bpp Options format."; }
/**
* @brief Write a Parametrizable to a stream.
*
* @param parametrizable A pointer to a Parametrizable object;
* @param out The output stream;
* @param writtenNames is the vector of the written
* parameters so far [in, out];
* @param printComma boolean if a comma should be written at the
* beginning of the description.
*/
void write(const Parametrizable* parametrizable,
OutputStream& out,
std::vector<std::string>& writtenNames,
bool printComma = false) const;
/**
* @brief Write a ParameterAliasable to a stream.
*
* @param parametrizable A pointer to a Parametrizable object;
* @param out The output stream;
* @param globalAliases parameters linked to global alias;
* @param names the names of the parameters to be written;
* @param writtenNames is the vector of the written
* parameters so far [in, out];
* @param printLocalAliases boolean if local aliases should be written;
* @param printComma boolean if a comma should be written at the
* beginning of the description.
*/
void write(const ParameterAliasable* parametrizable,
OutputStream& out,
std::map<std::string, std::string>& globalAliases,
const std::vector<std::string>& names,
std::vector<std::string>& writtenNames,
bool printLocalAliases = true,
bool printComma = false) const;
};
} //end of namespace bpp.
#endif //_BPPOPARAMETRIZABLEFORMAT_H_
|