Line< unsigned char > Class Template Reference

Public Member Functions
	Line ()
	Constructor. More...
unsigned char	next ()
	Increments one step along the line. More...
void	set (unsigned char value)
	Set the current value of the line. More...
void	set (unsigned char targetvalue, unsigned char 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 char startvalue, unsigned char targetvalue, unsigned char 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...

Detailed Description

template<>
class Line< unsigned char >

Definition at line 112 of file Line.h.

Constructor & Destructor Documentation

Line()

Line< unsigned char >::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 122 of file Line.h.

Member Function Documentation

next()

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

inline

Increments one step along the line.

Returns

the next value.

Definition at line 133 of file Line.h.

set() [1/3]

void Line< unsigned char >::set ( unsigned char  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 147 of file Line.h.

set() [2/3]

void Line< unsigned char >::set ( unsigned char  targetvalue, unsigned char  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 159 of file Line.h.

set() [3/3]

void Line< unsigned char >::set ( unsigned char  startvalue, unsigned char  targetvalue, unsigned char  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 170 of file Line.h.