owlps/owlps-positioner/src/direction.hh

125 lines
3.3 KiB
C++

/*
* This file is part of the Owl Positioning System (OwlPS).
* OwlPS is a project of the University of Franche-Comte
* (Université de Franche-Comté), France.
*
* Copyright © Université de Franche-Comté 2007-2012.
*
* Corresponding author: Matteo Cypriani <mcy@lm7.fr>
*
***********************************************************************
*
* 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 authors, 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 _OWLPS_POSITIONING_DIRECTION_HH_
#define _OWLPS_POSITIONING_DIRECTION_HH_
#include <string>
/// \brief Represents a direction in which a mobile is when it sends a
/// CalibrationRequest
class Direction
{
protected:
char direction ;
void assert_valid(void) const ;
bool is_valid(void) const ;
public:
enum {north = 1, east, south, west} ;
Direction(void): direction(0) {}
Direction(const char source) ;
Direction(const Direction &source): direction(source.direction) {}
/** @name Accessors */
//@{
void clear(void) ;
//@}
/** @name Operators */
//@{
Direction& operator=(const Direction &source) ;
Direction& operator=(const char source) ;
bool operator==(const Direction &source) const ;
bool operator!=(const Direction &source) const ;
operator bool(void) const ;
operator int(void) const ;
operator std::string(void) const ;
//@}
// Hashes a Direction
friend size_t hash_value(const Direction &source) ;
} ;
/* *** Accessors *** */
inline void Direction::clear()
{
direction = 0 ;
}
/* *** Operators *** */
inline bool Direction::operator==(const Direction &source) const
{
return direction == source.direction ;
}
inline bool Direction::operator!=(const Direction &source) const
{
return !(*this == source) ;
}
inline Direction::operator bool() const
{
return is_valid() ;
}
inline Direction::operator int() const
{
return static_cast<int>(direction) ;
}
#endif // _OWLPS_POSITIONING_DIRECTION_HH_