RobotFlow::VirtualJoystick Class Reference

#include <VirtualJoystick.h>

Inheritance diagram for RobotFlow::VirtualJoystick:

[legend]Collaboration diagram for RobotFlow::VirtualJoystick:

[legend]

---

Detailed Description

Virtual Joystick is a visual probe that shows a joystick with 2 standard buttons and 2 toggle buttons.

Author:

Dominic Letourneau

Public Member Functions
	VirtualJoystick (std::string nodeName, FD::ParameterSet params)
virtual	~VirtualJoystick ()
	Destructor.
virtual void	initialize ()
virtual void	calculate (int output_id, int count, FD::Buffer &out)
gint	event (GdkEvent *event)
bool	change_button_status (int button_id)
virtual ObjectRef	getOutput (int output_id, int count)
virtual void	request (int outputID, const ParameterSet &req)
virtual void	reset ()
virtual int	addOutput (const std::string &outputName)
virtual int	addInput (const std::string &inputName)
virtual void	initializeBuffers ()
virtual void	performRequests ()
virtual ObjectRef	getOutputNamed (const std::string &outputName, int count)
virtual void	connectToNode (std::string in, Node *inputNode, std::string out)
virtual bool	hasOutput (int output_id) const
ObjectRef	getInput (int inputID, int count)
virtual void	stop ()
virtual void	cleanupNotify ()
std::string	getName ()
virtual void	verifyConnect ()
void	printOn (std::ostream &out=std::cout) const
void	setUINode (UINode *_uinode)
void	ref ()
void	unref ()
int	unique ()
virtual void	destroy ()
virtual void	serialize (std::ostream &out) const
virtual void	unserialize (std::istream &in)
virtual void	doesNotUnderstand (std::string method)
virtual bool	isNil () const
virtual void	prettyPrint (std::ostream &out=std::cout) const
virtual void	readFrom (std::istream &in=std::cin)
virtual ObjectRef	clone ()
virtual std::string	className () const
Static Public Member Functions
static int	addFactory (const std::string &factoryName, _NodeFactory *const factory)
static int	addXPM (const std::string &nodeName, char **XPMData)
static char **	getXPM (const std::string &nodeName)
static _NodeFactory *	getFactoryNamed (const std::string &name)
static std::map< std::string, _NodeFactory * > &	factoryDictionary ()
static std::vector< std::string > &	nodeInfo ()
static std::map< std::string, char ** > &	XPMDictionary ()
static int	addNodeInfo (const std::string &info)
static ObjectRef	newObject (const std::string &objType)
static int	addObjectType (const std::string &objType, _ObjectFactory *factory)
static std::map< std::string, _ObjectFactory * > &	ObjectFactoryDictionary ()
static TypeMap< _ObjectFactory * > &	TypeidDictionary ()
Protected Member Functions
virtual void	connectToNode (unsigned int in, Node *inputNode, unsigned int out)
virtual std::vector< NodeInput > &	getInputs ()
virtual int	translateInput (std::string inputName)
virtual int	translateOutput (std::string inputName)
virtual void	rt_assert (bool cond, std::string message="", char *_file="unknown", int _line=0)
virtual void	construct_assert (bool cond, std::string message="", char *_file="unknown", int _line=0)
virtual void	throw_error (bool send_ptr, std::string message, char *_file, int _line)
Protected Attributes
bool	m_buttonsVisible
	Flag for the visibility of all the buttons.
bool	m_button1_on
	button 1 state
bool	m_button2_on
	button 2 state
bool	m_toggleButton3_on
	button 3 state
bool	m_toggleButton4_on
	button 4 state
int	m_outputID
	The output vector containing the state of the virtual joystick.
GtkWidget *	m_pWindow1
GtkWidget *	m_pVbox2
GtkWidget *	m_pToolbar2
GnomeCanvas *	m_pCanvas
GnomeCanvasGroup *	m_pGroup
GtkWidget *	m_pButton1
GtkWidget *	m_pButton2
GtkWidget *	m_pButton3
GtkWidget *	m_pButton4
GnomeCanvasItem *	m_pBorder
GnomeCanvasItem *	m_pHandle
int	processCount
std::vector< OutputCacheInfo >	outputs
std::vector< InputCacheInfo >	inputsCache
bool	inOrder
std::string	name
std::vector< NodeInput >	inputs
std::vector< std::string >	outputNames
ParameterSet	parameters
UINode *	uinode
AtomicCounter	ref_count
Friends
friend std::ostream &	operator<< (std::ostream &out, const Object &obj)

---

Constructor & Destructor Documentation

RobotFlow::VirtualJoystick::VirtualJoystick (  std::string  nodeName, FD::ParameterSet  params )

Constructor Parameters: nodeName  The name of the node params  The parameters passed at construction

RobotFlow::VirtualJoystick::~VirtualJoystick (   )  [virtual]

---

Member Function Documentation

void RobotFlow::VirtualJoystick::calculate (  int  output_id, int  count, FD::Buffer &  out )  [virtual]

Calculate inherited from BufferedNode Parameters: output_id  the output to calculate count  the iteration number out  the buffer where to write the result Implements FD::BufferedNode.

bool RobotFlow::VirtualJoystick::change_button_status (  int  button_id  )

Called when a button changed its status Parameters: button_id  the id of the button

gint RobotFlow::VirtualJoystick::event (  GdkEvent *  event  )

Catch a GdkEvent on the canvas Parameters: event  The GdkEvent

void RobotFlow::VirtualJoystick::initialize (   )  [virtual]

Class specific initialization routine. Each class will call its subclass specificInitialize() method Reimplemented from FD::BufferedNode.

---

Field Documentation

bool RobotFlow::VirtualJoystick::m_button1_on [protected]

bool RobotFlow::VirtualJoystick::m_button2_on [protected]

bool RobotFlow::VirtualJoystick::m_buttonsVisible [protected]

int RobotFlow::VirtualJoystick::m_outputID [protected]

GnomeCanvasItem* RobotFlow::VirtualJoystick::m_pBorder [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pButton1 [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pButton2 [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pButton3 [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pButton4 [protected]

GnomeCanvas* RobotFlow::VirtualJoystick::m_pCanvas [protected]

GnomeCanvasGroup* RobotFlow::VirtualJoystick::m_pGroup [protected]

GnomeCanvasItem* RobotFlow::VirtualJoystick::m_pHandle [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pToolbar2 [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pVbox2 [protected]

GtkWidget* RobotFlow::VirtualJoystick::m_pWindow1 [protected]

bool RobotFlow::VirtualJoystick::m_toggleButton3_on [protected]

bool RobotFlow::VirtualJoystick::m_toggleButton4_on [protected]

---

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

• Probes/include/VirtualJoystick.h
• Probes/src/VirtualJoystick.cc

---