---

vpControl Class Reference

Class to encapsulate control data for the vpHash map. More...

#include <vpControl.h>

List of all members.

Public Methods
	vpControl (unsigned char source_type, unsigned char source_numID, unsigned char source_channel)
	Constructor. More...
void	set (unsigned char source_type, unsigned char source_numID, unsigned char source_channel)
	Sets the contents of vpControl to the given values. More...
unsigned char	Type ()
	Retrieve the value of the type field. More...
unsigned char	NumID ()
	Retrieve the value of the numID field. More...
unsigned char	Channel ()
	Retrieve the value of the channel field. More...
	vpControl ()
	Default constructor.
virtual	~vpControl ()
	Destructor.
Private Attributes
unsigned long	unity
	Variable holding the combined value of type, numID, and channel. More...
Friends
bool	operator< (const vpControl &x, const vpControl &y)
	Overloaded less then operator.

---

Detailed Description

Class to encapsulate control data for the vpHash map.

Author:

Elan Ruskin <eruskin+doxy@andrew.cmu.edu>

---

Constructor & Destructor Documentation

vpControl::vpControl (  unsigned char    source_type, unsigned char    source_numID, unsigned char    source_channel )  [inline]

Constructor. Use this constructor to create a "control" class from a triplet of source identifiers. eg x=new vpControl(2,7,3); Parameters: source_type  The value for the type field. source_numID  The value for the numID field. source_channel  The value for the channel field.

---

Member Function Documentation

unsigned char vpControl::Channel (    )  [inline]

Retrieve the value of the channel field. Returns: The value of the channel field.

unsigned char vpControl::NumID (    )  [inline]

Retrieve the value of the numID field. Returns: The value of the numID field.

unsigned char vpControl::Type (    )  [inline]

Retrieve the value of the type field. Returns: The value of the type field.

void vpControl::set (  unsigned char    source_type, unsigned char    source_numID, unsigned char    source_channel )  [inline]

Sets the contents of vpControl to the given values. Parameters: source_type  The value for the type field. source_numID  The value for the numID field. source_channel  The value for the channel field.

---

Member Data Documentation

unsigned long vpControl::unity [private]

Variable holding the combined value of type, numID, and channel. unity = (((long) source_type) << 16) | (((long) source_numID) << 8) | (((long) source_channel));

---

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

• vpControl.h
• vpControl.cpp

---