msl::PhaseCycling Class Reference

Detailed Description

Compute phase cycling with linear and quadratic increments.

#include <PhaseCycling.h>

Public Member Functions
	PhaseCycling (long linearIncrement=0, long quadraticIncrement=0)
	Create a phase cycling object with specified increments.
long	linearIncrement () const
	Return the linear increment of the phase cycling, in degrees.
PhaseCycling &	setLinearIncrement (long linearIncrement)
	Set the linear increment of the phase cycling, in degrees.
long	quadraticIncrement () const
	Return the quadratic increment of the phase cycling, in degrees.
PhaseCycling &	setQuadraticIncrement (long quadraticIncrement)
	Set the quadratic increment of the phase cycling, in degrees.
long	phase () const
	Return the current phase in degrees modulo 360.
PhaseCycling &	operator++ ()
	Increment the phase cycling and return the current object.
PhaseCycling	operator++ (int)
	Increment the phase cycling and return the previous object.
PhaseCycling &	reset ()
	Reset the phase cycling to 0.

Constructor & Destructor Documentation

PhaseCycling()

msl::PhaseCycling::PhaseCycling	(	long	linearIncrement = 0,
		long	quadraticIncrement = 0
	)

Create a phase cycling object with specified increments.

Member Function Documentation

linearIncrement()

long msl::PhaseCycling::linearIncrement

(

)

const

Return the linear increment of the phase cycling, in degrees.

setLinearIncrement()

PhaseCycling & msl::PhaseCycling::setLinearIncrement

(

long

linearIncrement

)

Set the linear increment of the phase cycling, in degrees.

quadraticIncrement()

long msl::PhaseCycling::quadraticIncrement

(

)

const

Return the quadratic increment of the phase cycling, in degrees.

setQuadraticIncrement()

PhaseCycling & msl::PhaseCycling::setQuadraticIncrement

(

long

quadraticIncrement

)

Set the quadratic increment of the phase cycling, in degrees.

phase()

long msl::PhaseCycling::phase

(

)

const

Return the current phase in degrees modulo 360.

operator++() [1/2]

PhaseCycling & msl::PhaseCycling::operator++

(

)

Increment the phase cycling and return the current object.

operator++() [2/2]

PhaseCycling msl::PhaseCycling::operator++

(

int

)

Increment the phase cycling and return the previous object.

reset()

PhaseCycling & msl::PhaseCycling::reset

(

)

Reset the phase cycling to 0.

---

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

• msl/PhaseCycling.h