Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

AngSignPi Class Reference

#include <Measures.h>

List of all members.


Detailed Description

Circular arithmetic on angles between -pi and pi (360 degrees).

Definition at line 75 of file Measures.h.


Public Member Functions

 AngSignPi (void)
 AngSignPi (direction_t const &v)
 constructor, value defaults to 0
AngSignPi operator+ (AngSignPi const &arg) const
AngSignPi operator- (AngSignPi const &arg) const
AngSignPi operator * (direction_t const &arg) const
AngSignPi operator/ (direction_t const &arg) const
AngSignPioperator= (AngSignPi const &arg)
AngSignPioperator= (direction_t const &arg)
AngSignPioperator+= (direction_t const &arg)
AngSignPioperator-= (direction_t const &arg)
AngSignPioperator *= (direction_t const &arg)
AngSignPioperator/= (direction_t const &arg)
 operator direction_t () const

Protected Member Functions

void normalize ()
 conversion operator for going back to the primitive type

Protected Attributes

direction_t value
 holds the angle, should be kept normalized at all times

Friends

AngPi angdist (AngSignPi const &arg1, AngSignPi const &arg2)
 Angular distance: value is between 0 and pi.

Constructor & Destructor Documentation

AngSignPi::AngSignPi ( void   )  [inline]

Definition at line 78 of file Measures.h.

Referenced by operator *(), operator+(), operator-(), and operator/().

AngSignPi::AngSignPi ( direction_t const &  v  )  [inline]

constructor, value defaults to 0

conversion operator allows implicit construction from primitive

Definition at line 79 of file Measures.h.


Member Function Documentation

AngSignPi AngSignPi::operator+ ( AngSignPi const &  arg  )  const [inline]

Definition at line 81 of file Measures.h.

AngSignPi AngSignPi::operator- ( AngSignPi const &  arg  )  const [inline]

Definition at line 82 of file Measures.h.

AngSignPi AngSignPi::operator * ( direction_t const &  arg  )  const [inline]

Definition at line 83 of file Measures.h.

AngSignPi AngSignPi::operator/ ( direction_t const &  arg  )  const [inline]

Definition at line 84 of file Measures.h.

AngSignPi& AngSignPi::operator= ( AngSignPi const &  arg  )  [inline]

Definition at line 86 of file Measures.h.

AngSignPi& AngSignPi::operator= ( direction_t const &  arg  )  [inline]

Definition at line 87 of file Measures.h.

AngSignPi& AngSignPi::operator+= ( direction_t const &  arg  )  [inline]

Definition at line 88 of file Measures.h.

AngSignPi& AngSignPi::operator-= ( direction_t const &  arg  )  [inline]

Definition at line 89 of file Measures.h.

AngSignPi& AngSignPi::operator *= ( direction_t const &  arg  )  [inline]

Definition at line 90 of file Measures.h.

AngSignPi& AngSignPi::operator/= ( direction_t const &  arg  )  [inline]

Definition at line 91 of file Measures.h.

AngSignPi::operator direction_t (  )  const [inline]

Definition at line 93 of file Measures.h.

void AngSignPi::normalize (  )  [protected]

conversion operator for going back to the primitive type

modifies value to put it back in range

Definition at line 48 of file Measures.cc.

Referenced by AngSignPi(), operator *=(), operator+=(), operator-=(), operator/=(), and operator=().


Friends And Related Function Documentation

AngPi angdist ( AngSignPi const &  arg1,
AngSignPi const &  arg2 
) [friend]

Angular distance: value is between 0 and pi.

Definition at line 63 of file Measures.cc.


Member Data Documentation

holds the angle, should be kept normalized at all times

Definition at line 97 of file Measures.h.

Referenced by angdist(), normalize(), operator *(), operator *=(), operator direction_t(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), and operator=().


The documentation for this class was generated from the following files:

Tekkotsu v4.0
Generated Thu Nov 22 00:58:08 2007 by Doxygen 1.5.4