#include <Phase.h>

Public Member Functions
	Phase (const Phase &other)

	Phase (double ph_in=0)

	operator double () const

Phase &	operator *= (double rhs)

Phase &	operator/= (double rhs)

Phase &	operator+= (const Phase &rhs)

Phase	operator+ (const Phase &rhs) const

const Phase &	operator+ () const

Phase &	operator-= (const Phase &rhs)

Phase	operator- (const Phase &rhs) const

Phase	operator- () const

double	inDegrees () const

void	testPhase (std::ostream &os=std::cout) const

Static Public Member Functions
static double	rangeMax ()

static double	rangeMin ()

Protected Member Functions
void	toRange ()

Protected Attributes
double	_ph

Static Protected Attributes
static const double	_minPh = 0

Detailed Description

Definition at line 9 of file Phase.h.

Constructor & Destructor Documentation

◆ Phase() [1/2]

Phase::Phase ( const Phase & other )

Definition at line 23 of file Phase.cpp.

   : _ph(other._ph){
   toRange();
 }

◆ Phase() [2/2]

Phase::Phase ( double ph_in = 0 )

Definition at line 27 of file Phase.cpp.

   : _ph(ph_in){
   toRange();
 }

Member Function Documentation

◆ inDegrees()

double Phase::inDegrees ( ) const

Definition at line 69 of file Phase.cpp.

                              {
   return _ph * 180.0/pi;
 }

◆ operator *=()

Phase & Phase::operator *= ( double rhs )

Definition at line 31 of file Phase.cpp.

                                   {
   _ph *= rhs;
   toRange();
   return *this;
 }

◆ operator double()

MINT::Phase::operator double ( ) const

inline

Definition at line 17 of file Phase.h.

                          {
     return _ph;
   }

◆ operator+() [1/2]

Phase Phase::operator+ ( const Phase & rhs ) const

Definition at line 46 of file Phase.cpp.

                                             {
   Phase newPhase(*this);
   newPhase += rhs;
   return newPhase;
 }  

◆ operator+() [2/2]

const Phase & Phase::operator+ ( ) const

Definition at line 51 of file Phase.cpp.

                                    {
   return (*this);
 }  

◆ operator+=()

Phase & Phase::operator+= ( const Phase & rhs )

Definition at line 41 of file Phase.cpp.

                                         {
   _ph += (double) rhs;
   toRange();
   return *this;
 }

◆ operator-() [1/2]

Phase Phase::operator- ( const Phase & rhs ) const

Definition at line 59 of file Phase.cpp.

                                             {
   Phase newPhase(*this);
   newPhase -= rhs;
   return newPhase;
 }

◆ operator-() [2/2]

Phase Phase::operator- ( ) const

Definition at line 64 of file Phase.cpp.

                             {
   Phase newPhase(*this);
   newPhase *= -1.;
   return newPhase;
 }

◆ operator-=()

Phase & Phase::operator-= ( const Phase & rhs )

Definition at line 54 of file Phase.cpp.

                                         {
   _ph -= (double) rhs;
   _ph = fmod(_ph, twopi);
   return *this;
 }

◆ operator/=()

Phase & Phase::operator/= ( double rhs )

Definition at line 36 of file Phase.cpp.

                                   {
   _ph /= rhs;
   toRange();
   return *this;
 }

◆ rangeMax()

double Phase::rangeMax ( )

static

Definition at line 13 of file Phase.cpp.

                       {
   return _minPh + twopi;
 }

◆ rangeMin()

double Phase::rangeMin ( )

static

Definition at line 16 of file Phase.cpp.

                       {
   return _minPh;
 }

◆ testPhase()

void Phase::testPhase ( std::ostream & os = std::cout ) const

Definition at line 73 of file Phase.cpp.

                                          {
   os << " testing Phase object:" << endl;
   Phase testPhase(9);
   os << " testPhase(9) " << testPhase 
      << "( = " << testPhase.inDegrees() << " deg)"
      << endl;
   Phase otherPhase(6);
   os << " otherPhase(3) " <<  otherPhase
      << "( = " << otherPhase.inDegrees() << " deg)"
      << endl;
 
   os << " sum of the two =" 
      << (otherPhase + testPhase).inDegrees()
      << " deg \n difference: " 
      << (otherPhase - testPhase).inDegrees()
      << " deg \n negative of testPhase "
      << -testPhase
      << " = " << (-testPhase).inDegrees() 
      << " deg" << endl;
   return;
 }

◆ toRange()

void Phase::toRange ( )

protected

Definition at line 19 of file Phase.cpp.

                    {
   while (_ph >  rangeMax()) _ph -= 2 * pi;
   while (_ph <  rangeMin()) _ph += 2 * pi;
 }

Member Data Documentation

◆ _minPh

const double Phase::_minPh = 0

staticprotected

Definition at line 12 of file Phase.h.

◆ _ph

double MINT::Phase::_ph