Line< unsigned int > Class Reference

Detailed Description

Definition at line 183 of file Line.h.

Public Member Functions
	Line ()
	Constructor. More...
unsigned int	next ()
	Increments one step along the line. More...
void	set (unsigned int value)
	Set the current value of the line. More...
void	set (unsigned int targetvalue, unsigned int num_steps)
	Given a target value and the number of steps to take on the way, this calculates the step size needed to get there from the current value. More...
void	set (unsigned int startvalue, unsigned int targetvalue, unsigned int num_steps)
	Given a new starting value, target value and the number of steps to take on the way, this sets the step size needed to get there. More...

Constructor & Destructor Documentation

Line()

Line< unsigned int >::Line ( )

inline

Constructor.

Use the template parameter to set the type of numbers you want to use. For example, Line <int> myline; makes a Line which uses ints.

Definition at line 193 of file Line.h.

Member Function Documentation

next()

unsigned int Line< unsigned int >::next ( )

inline

Increments one step along the line.

Returns

the next value.

Definition at line 204 of file Line.h.

set() [1/3]

void Line< unsigned int >::set ( unsigned int  startvalue, unsigned int  targetvalue, unsigned int  num_steps  )

inline

Given a new starting value, target value and the number of steps to take on the way, this sets the step size needed to get there.

Parameters

startvalue	the number to set the Line's current_value to.
targetvalue	the value to move towards.
num_steps	how many steps to take to reach the target.

Definition at line 242 of file Line.h.

set() [2/3]

void Line< unsigned int >::set ( unsigned int  targetvalue, unsigned int  num_steps  )

inline

Given a target value and the number of steps to take on the way, this calculates the step size needed to get there from the current value.

Parameters

targetvalue	the value to move towards.
num_steps	how many steps to take to reach the target.

Definition at line 230 of file Line.h.

set() [3/3]

void Line< unsigned int >::set ( unsigned int  value )

inline

Set the current value of the line.

The Line will continue incrementing from this value using any previously calculated step size.

Parameters

value

the number to set the Line's current_value to.

Definition at line 218 of file Line.h.