owlps/owlps-positioner/area.hh

147 lines
3.1 KiB
C++

/*
* This file is part of the Owl Positioning System (OwlPS) project.
* It is subject to the copyright notice and license terms in the
* COPYRIGHT.t2t file found in the top-level directory of this
* distribution and at
* https://code.lm7.fr/mcy/owlps/src/master/COPYRIGHT.t2t
* No part of the OwlPS Project, including this file, may be copied,
* modified, propagated, or distributed except according to the terms
* contained in the COPYRIGHT.t2t file; the COPYRIGHT.t2t file must be
* distributed along with this file, either separately or by replacing
* this notice by the COPYRIGHT.t2t file's contents.
*/
#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:
const Building *building ; ///< 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
/// Reorders #p_min and #p_max
void reorder_coordinates(void) ;
public:
Area(const Building *const _building = nullptr,
const std::string &_name = "Unnamed area",
const Point3D &p1 = Point3D(0,0,0),
const Point3D &p2 = Point3D(0,0,0)) ;
Area(const Area &source):
building(source.building), name(source.name),
p_min(source.p_min), p_max(source.p_max) {}
~Area(void) {}
/** @name Read accessors */
//@{
const Building* get_building(void) const ;
const std::string& get_name(void) const ;
const Point3D& get_p_min(void) const ;
const Point3D& get_p_max(void) const ;
//@}
/** @name Write accessors */
//@{
void set_building(const Building *const _building) ;
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 */
//@{
Area& operator=(const Area &source) ;
bool operator==(const Area &source) const ;
bool operator!=(const Area &source) const ;
//@}
/// Displays an Area
friend std::ostream &operator<<(std::ostream &os, const Area &a) ;
} ;
/* *** Read accessors *** */
inline const 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 *const _building)
{
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 &source) const
{
return !(*this == source) ;
}
#endif // _OWLPS_POSITIONING_AREA_HH_