Angle Class Reference

List of all members.

Detailed Description

Angle between 0 and $2\pi$

This class provides an angle between 0 and $\pi$ radians. All operations on the value of the angle are adjusted so that the value is always in the correct range.

Author:
Bill Smart
Date:
September 2003
Version:
1.0

Definition at line 45 of file Angle.H.

Public Member Functions

 Angle ()
 Standard constructor.
 Angle (const double value)
 Standard constructor.
 Angle (const Angle &angle)
 Copy constructor.
 ~Angle ()
 Standard destructor.
Operators
Angleoperator= (const Angle &angle)
 Assignment operator.
Angleoperator= (const double value)
 Assignment operator.
Angleoperator+= (const double value)
 Add to the angle.
Angleoperator-= (const double value)
 Subtract from the angle.
Angleoperator *= (const double value)
 Multiply the angle.
Angleoperator/= (const double value)
 Divide the angle.
Accessing the angle value
 operator double () const
 Access the value in radians.
double degrees () const
 Access the value in degrees.

Private Member Functions

void clip ()

Private Attributes

double m_value

Friends

std::istream & operator>> (std::istream &in, Angle &angle)
 Standard input stream operator.


Constructor & Destructor Documentation

Angle (  )  [inline]

Standard constructor.

Definition at line 52 of file Angle.H.

Angle ( const double  value  )  [inline]

Standard constructor.

Parameters:
value The initial value of the angle.

Definition at line 55 of file Angle.H.

References clip().

Angle ( const Angle angle  )  [inline]

Copy constructor.

Parameters:
angle The instance to copy from.

Definition at line 58 of file Angle.H.

~Angle (  )  [inline]

Standard destructor.

Definition at line 60 of file Angle.H.


Member Function Documentation

Angle& operator= ( const Angle angle  )  [inline]

Assignment operator.

Parameters:
angle The instance to assign from.

Definition at line 66 of file Angle.H.

References m_value.

Angle& operator= ( const double  value  )  [inline]

Assignment operator.

Parameters:
value The new value of the angle.

Definition at line 70 of file Angle.H.

References clip(), and m_value.

Angle& operator+= ( const double  value  )  [inline]

Add to the angle.

Parameters:
value The angle to add.

Definition at line 75 of file Angle.H.

References clip(), and m_value.

Angle& operator-= ( const double  value  )  [inline]

Subtract from the angle.

Parameters:
value The angle to subtract.

Definition at line 79 of file Angle.H.

References clip(), and m_value.

Angle& operator *= ( const double  value  )  [inline]

Multiply the angle.

Parameters:
value The value to multiply by.

Definition at line 83 of file Angle.H.

References clip(), and m_value.

Angle& operator/= ( const double  value  )  [inline]

Divide the angle.

Parameters:
value The value to divide by.

Definition at line 87 of file Angle.H.

References clip(), and m_value.

operator double (  )  const [inline]

Access the value in radians.

Returns:
The angle as a double.

Definition at line 96 of file Angle.H.

References m_value.

double degrees (  )  const [inline]

Access the value in degrees.

Returns:
The angle in degrees.

Definition at line 99 of file Angle.H.

References m_value.

void clip (  )  [inline, private]

Definition at line 105 of file Angle.H.

References m_value.

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


Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in,
Angle angle 
) [friend]

Standard input stream operator.

Definition at line 47 of file Angle.H.


Member Data Documentation

double m_value [private]

Definition at line 103 of file Angle.H.

Referenced by clip(), degrees(), operator *=(), operator double(), operator+=(), operator-=(), operator/=(), and operator=().


The documentation for this class was generated from the following file:
Generated on Thu Feb 1 15:31:54 2007 for WURDE by  doxygen 1.5.1