Control3DAbstract Class Reference

#include <Control3DAbstract.h>

Inheritance diagram for Control3DAbstract:

Collaboration diagram for Control3DAbstract:

List of all members.

Public Member Functions
	Control3DAbstract ()
virtual	~Control3DAbstract ()
bool	Open ()
	Opens the connection to the serial port.
void	Close ()
	Closes the connection to the serial port.
void	SetPort (wxString connection)
	Sets a new port address.
wxString	GetPort ()
	Gets the port address.
bool	IsConnected ()
	Shows whether the connection is established.
int	GetButton (unsigned char i) const
	Returns the state of a given button.
int	GetAxis (unsigned char i) const
	Returns the state of a given axis.
bool	HasChanged ()
	Indicates a change during the last pumping of data.
bool	Pump ()
	Pumps data from the serial port to the packet analyser.
virtual const unsigned char	ReturnID ()=0
	Returns an ID for the given 6-DOF driver.
Protected Member Functions
virtual void	InitDevice ()
virtual bool	ProcessPacket ()=0
virtual void	DataIn (unsigned char c)=0
Protected Attributes
SerialPort	port
wxString	connection
int	Button [CONTROL3DABSTRACT_MAXBUTTONS]
int	Axis [6]
bool	hasChanged

---

Constructor & Destructor Documentation

Control3DAbstract::Control3DAbstract

(

)

Control3DAbstract::~Control3DAbstract

(

)

[virtual]

---

Member Function Documentation

void Control3DAbstract::Close

(

void

)

Closes the connection to the serial port.

virtual void Control3DAbstract::DataIn

(

unsigned char

c

)

[protected, pure virtual]

Implemented in ControlSpaceBall, ControlSpaceMouse, and ControlSpaceOrb.

int Control3DAbstract::GetAxis

(

unsigned char

i

)

const

Returns the state of a given axis.

int Control3DAbstract::GetButton

(

unsigned char

i

)

const

Returns the state of a given button.

wxString Control3DAbstract::GetPort

(

)

Gets the port address.

bool Control3DAbstract::HasChanged

(

)

[inline]

Indicates a change during the last pumping of data.

void Control3DAbstract::InitDevice

(

)

[protected, virtual]

Reimplemented in ControlSpaceBall, ControlSpaceMouse, and ControlSpaceOrb.

bool Control3DAbstract::IsConnected

(

)

[inline]

Shows whether the connection is established.

bool Control3DAbstract::Open

(

void

)

Opens the connection to the serial port.

virtual bool Control3DAbstract::ProcessPacket

(

)

[protected, pure virtual]

Implemented in ControlSpaceBall, ControlSpaceMouse, and ControlSpaceOrb.

bool Control3DAbstract::Pump

(

)

Pumps data from the serial port to the packet analyser.

virtual const unsigned char Control3DAbstract::ReturnID

(

)

[pure virtual]

Returns an ID for the given 6-DOF driver.

Implemented in ControlSpaceBall, ControlSpaceMouse, and ControlSpaceOrb.

void Control3DAbstract::SetPort

(

wxString

connection

)

Sets a new port address.

---

Member Data Documentation

int Control3DAbstract::Axis[6] [protected]

int Control3DAbstract::Button[CONTROL3DABSTRACT_MAXBUTTONS] [protected]

wxString Control3DAbstract::connection [protected]

bool Control3DAbstract::hasChanged [protected]

SerialPort Control3DAbstract::port [protected]

---

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

• GenericCAM/src/controller/Control3DAbstract.h
• GenericCAM/src/controller/Control3DAbstract.cpp