rec::robotino::api2::CustomMessage Class Reference

Represents Robotino's custom message communication channel module. More...

#include <CustomMessage.h>

Inheritance diagram for rec::robotino::api2::CustomMessage:

Public Member Functions
void	setComId (const ComId &id)
void	processEvents ()
void	setCustomMessage (unsigned int id, const char *const data, unsigned int dataSize)
virtual void	customMessageEvent (unsigned int id, const char *const data, unsigned int dataSize)
Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()
virtual	~ComObject ()
ComId	comId () const

Friends
class	CustomMessageImpl

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

Represents Robotino's custom message communication channel module.

Member Function Documentation

virtual void rec::robotino::api2::CustomMessage::customMessageEvent ( unsigned int  id, const char *const  data, unsigned int  dataSize  )

virtual

Called when new CustomMessage response data is available.

Parameters

id	A custom id
data	The custom message payload data

Remarks

dataSize Number of bytes in data

This function is called from the thread in which Com::processEvents() is called.

See also

Com::processEvents

void rec::robotino::api2::CustomMessage::processEvents

(

)

Call this function from your main thread to get the virtual CustomMessage functions called. The virtual functions are called directly by a call of this function

Exceptions

nothing

See also

Com::processEvents

void rec::robotino::api2::CustomMessage::setComId

(

const ComId &

id

)

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

void rec::robotino::api2::CustomMessage::setCustomMessage	(	unsigned int	id,
		const char *const	data,
		unsigned int	dataSize
	)

Send a request

Parameters

id	A custom id
data	The custom message payload data

Remarks

dataSize Number of bytes in data

See also

Com::processEvents

---

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

• C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/CustomMessage.h