Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

AngSignPi Class Reference

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

#include <Measures.h>


Detailed Description

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

Definition at line 103 of file Measures.h.

List of all members.

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   ) 

Definition at line 106 of file Measures.h.

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

AngSignPi::AngSignPi ( direction_t const &  v  ) 

constructor, value defaults to 0

conversion operator allows implicit construction from primitive

Definition at line 107 of file Measures.h.


Member Function Documentation

void AngSignPi::normalize (  )  [protected]

conversion operator for going back to the primitive type

modifies value to put it back in range

Definition at line 73 of file Measures.cc.

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

AngSignPi::operator direction_t (  )  const

Definition at line 121 of file Measures.h.

AngSignPi AngSignPi::operator* ( direction_t const &  arg  )  const

Definition at line 111 of file Measures.h.

AngSignPi& AngSignPi::operator*= ( direction_t const &  arg  ) 

Definition at line 118 of file Measures.h.

AngSignPi AngSignPi::operator+ ( AngSignPi const &  arg  )  const

Definition at line 109 of file Measures.h.

AngSignPi& AngSignPi::operator+= ( direction_t const &  arg  ) 

Definition at line 116 of file Measures.h.

AngSignPi AngSignPi::operator- ( AngSignPi const &  arg  )  const

Definition at line 110 of file Measures.h.

AngSignPi& AngSignPi::operator-= ( direction_t const &  arg  ) 

Definition at line 117 of file Measures.h.

AngSignPi AngSignPi::operator/ ( direction_t const &  arg  )  const

Definition at line 112 of file Measures.h.

AngSignPi& AngSignPi::operator/= ( direction_t const &  arg  ) 

Definition at line 119 of file Measures.h.

AngSignPi& AngSignPi::operator= ( direction_t const &  arg  ) 

Definition at line 115 of file Measures.h.

AngSignPi& AngSignPi::operator= ( AngSignPi const &  arg  ) 

Definition at line 114 of file Measures.h.


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 93 of file Measures.cc.


Member Data Documentation

holds the angle, should be kept normalized at all times

Definition at line 125 of file Measures.h.

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


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:04 2016 by Doxygen 1.6.3