Locality.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef _LOCALITY_H_
#define _LOCALITY_H_
 
// From std lib
#include <string>
 
#include <Bpp/Graphics/Point2D.h>
 
namespace bpp
{
template<class T> class Locality :
  public bpp::Point2D<T>
{
protected:
  std::string name_;
 
public:
  // Constructors and destructor
  Locality<T>(const std::string name, const T x = 0, const T y = 0) :
    bpp::Point2D<T>(x, y),
    name_(name) {}
 
  Locality<T>(const std::string name, const bpp::Point2D<T>& coord) :
    bpp::Point2D<T>(coord),
    name_(name) {}
 
  virtual ~Locality<T>() {}
 
public:
  // Methodes
  Locality<T>* clone() const { return new Locality<T>(*this); }
 
  virtual bool operator==(const Locality<T>& locality) const
  {
    return this->getX() == locality.getX() && this->getY() == locality.getY() && name_ == locality.name_;
  }
 
  virtual bool operator!=(const Locality<T>& locality) const
  {
    return !(locality == *this);
  }
 
  void setName(const std::string& name) { name_ = name; }
 
  const std::string& getName() const { return name_; }
};
} // end of namespace bpp;
 
#endif // _LOCALITY_H_