Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

AngPi Class Reference

#include <Measures.h>

List of all members.


Detailed Description

Circular arithmetic on angles between 0 and pi (180 degrees).

Definition at line 17 of file Measures.h.


Public Member Functions

 AngPi (void)
 AngPi (orientation_t const &v)
 constructor, value defaults to 0
AngPi operator+ (AngPi const &arg) const
AngPi operator- (AngPi const &arg) const
AngPi operator * (orientation_t const &arg) const
AngPi operator/ (orientation_t const &arg) const
AngPioperator= (AngPi const &arg)
AngPioperator= (orientation_t const &arg)
AngPioperator+= (orientation_t const &arg)
AngPioperator-= (orientation_t const &arg)
AngPioperator *= (orientation_t const &arg)
AngPioperator/= (orientation_t const &arg)
 operator orientation_t () const

Protected Member Functions

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

Protected Attributes

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

Friends

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

Constructor & Destructor Documentation

AngPi::AngPi ( void   )  [inline]

Definition at line 20 of file Measures.h.

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

AngPi::AngPi ( orientation_t const &  v  )  [inline]

constructor, value defaults to 0

conversion operator allows implicit construction from primitive

Definition at line 21 of file Measures.h.


Member Function Documentation

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

Definition at line 23 of file Measures.h.

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

Definition at line 24 of file Measures.h.

AngPi AngPi::operator * ( orientation_t const &  arg  )  const [inline]

Definition at line 25 of file Measures.h.

AngPi AngPi::operator/ ( orientation_t const &  arg  )  const [inline]

Definition at line 26 of file Measures.h.

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

Definition at line 28 of file Measures.h.

AngPi& AngPi::operator= ( orientation_t const &  arg  )  [inline]

Definition at line 29 of file Measures.h.

AngPi& AngPi::operator+= ( orientation_t const &  arg  )  [inline]

Definition at line 30 of file Measures.h.

AngPi& AngPi::operator-= ( orientation_t const &  arg  )  [inline]

Definition at line 31 of file Measures.h.

AngPi& AngPi::operator *= ( orientation_t const &  arg  )  [inline]

Definition at line 32 of file Measures.h.

AngPi& AngPi::operator/= ( orientation_t const &  arg  )  [inline]

Definition at line 33 of file Measures.h.

AngPi::operator orientation_t (  )  const [inline]

Definition at line 35 of file Measures.h.

void AngPi::normalize (  )  [protected]

conversion operator for going back to the primitive type

modifies value to put it back in range

Definition at line 3 of file Measures.cc.

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


Friends And Related Function Documentation

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

Angular distance: value is between 0 and pi/2.

Definition at line 19 of file Measures.cc.


Member Data Documentation

holds the angle, should be kept normalized at all times

Definition at line 39 of file Measures.h.

Referenced by angdist(), normalize(), operator *(), operator *=(), operator orientation_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