owlps/owlps-positioning/src/area.hh

#ifndef _OWLPS_POSITIONING_AREA_HH_
#define _OWLPS_POSITIONING_AREA_HH_

class Building ;

#include "point3d.hh"

#include <string>
#include <ostream>

/// Represents an homogeneous area (typically a room) of a Building
class Area
{
protected:
  Building *building ; ///< The Building in which the Area is
  std::string name ; ///< Name of the Area
  Point3D p_min ; ///< First coordinate of the Area
  Point3D p_max ; ///< Second coordinate of the Area

  void reorder_coordinates(void) ; ///< Reorders #p_min and #p_max

public:
  /// \brief Constructs an Area from a Building, a name and two 3-float
  /// defined points (or default constructor)
  Area(const Building *_building = NULL,
       const std::string &_name = "Unnamed area",
       const Point3D &p1 = Point3D(0,0,0),
       const Point3D &p2 = Point3D(0,0,0)) ;
  /// Copy constructor
  Area(const Area &a) ;

  ~Area(void) {} ///< Destructor (do nothing)

  /** @name Read accessors */
  //@{
  Building* get_building(void) const ; ///< #building read accessor
  const std::string& get_name(void) const ; ///< #name read accessor
  const Point3D& get_p_min(void) const ; ///< #p_min read accessor
  const Point3D& get_p_max(void) const ; ///< #p_max read accessor
  //@}

  /** @name Write accessors */
  //@{
  /// #building write accessor
  void set_building(const Building *_building) ;
  /// #name write accessor
  void set_name(const std::string &_name) ;
  /// Sets the coordinates of the Area and reorder them
  void set_coordinates(const Point3D &p1, const Point3D &p2) ;
  //@}

  /** @name Operations */
  //@{
  /// Checks if a Point3D is into the Area
  bool contains_point(const Point3D &p) const ;
  //@}

  /** @name Operators */
  //@{
  const Area& operator=(const Area &a) ;
  bool operator==(const Area &a) const ;
  bool operator!=(const Area &a) const ;
  //@}

  /// Displays an Area
  friend std::ostream &operator<<(std::ostream &os, const Area &a) ;
} ;



/* *** Read accessors *** */


inline Building* Area::get_building() const
{
  return building ;
}


inline const std::string& Area::get_name() const
{
  return name ;
}


inline const Point3D& Area::get_p_min() const
{
  return p_min ;
}


inline const Point3D& Area::get_p_max() const
{
  return p_max ;
}



/* *** Write accessors *** */


inline void Area::set_building(const Building *_building)
{
  building = const_cast<Building*>(_building) ;
}


inline void Area::set_name(const std::string &_name)
{
  name = _name ;
}


inline void Area::set_coordinates(const Point3D &p1, const Point3D &p2)
{
  p_min = p1 ;
  p_max = p2 ;
  reorder_coordinates() ;
}



/* *** Operators *** */


inline bool Area::operator!=(const Area &a) const
{
  return !(*this == a) ;
}



#endif // _OWLPS_POSITIONING_AREA_HH_