/usr/include/Bpp/PopGen/Locality.h is in libbpp-popgen-dev 2.1.0-1ubuntu2.
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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | //
// File Locality.h
// Author : Sylvain Gaillard
// Last modification : Thursday July 29 2004
//
/*
Copyright or © or Copr. CNRS, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for population genetics 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 _LOCALITY_H_
#define _LOCALITY_H_
// From std lib
#include <string>
#include <Bpp/Graphics/Point2D.h>
namespace bpp
{
/**
* @brief The Locality class.
*
* This is a class derivated from the Point2D class.
* It's a Point2D with a name.
*
* @author Sylvain Gaillard
*/
template<class T> class Locality :
public bpp::Point2D<T>
{
protected:
std::string name_;
public:
// Constructors and destructor
/**
* @brief Build a new locality with name and coordinates.
*
* @param name The name of the locality.
* @param x The longitude.
* @param y The latitude.
*/
Locality<T>(const std::string name, const T x = 0, const T y = 0) :
bpp::Point2D<T>(x, y),
name_(name) {}
/**
* @brief Build a new locality with name and coordinates.
*
* @param name The name of the locality.
* @param coord The coordinates of the locality.
*/
Locality<T>(const std::string name, const bpp::Point2D<T> &coord) :
bpp::Point2D<T>(coord),
name_(name) {}
/**
* @brief Destroy a locality.
*/
virtual ~Locality<T>() {}
public:
// Methodes
/**
* @brief Implements the Clonable interface.
*/
Locality<T>* clone() const { return new Locality<T>(*this); }
/**
* @brief The == operator.
*
* returns true if both name and coordinates are identical between the two Locality objects.
*/
virtual bool operator==(const Locality<T>& locality) const
{
return this->getX() == locality.getX() && this->getY() == locality.getY() && name_ == locality.name_;
}
/**
* @brief The != operator.
*/
virtual bool operator!=(const Locality<T>& locality) const
{
return !(locality == *this);
}
/**
* @brief Set the name of the locality.
*/
void setName(const std::string& name) { name_ = name; }
/**
* @brief Get the name of the locality.
*/
const std::string& getName() const { return name_; }
};
} // end of namespace bpp;
#endif // _LOCALITY_H_
|