A cheap and cheerful framework for human readable/writable forms of messages to devices. More...

#include <yarp/dev/DeviceDriver.h>

Inheritance diagram for yarp::dev::DeviceResponder:

Public Member Functions
	DeviceResponder ()
	Constructor. More...

void	addUsage (const char txt, const char explain=nullptr)
	Add information about a message that the respond() method understands. More...

void	addUsage (const yarp::os::Bottle &bot, const char *explain=nullptr)
	Add information about a message that the respond() method understands. More...

virtual bool	respond (const yarp::os::Bottle &command, yarp::os::Bottle &reply)
	Respond to a message. More...

bool	read (yarp::os::ConnectionReader &connection) override
	Handler for reading messages from the network, and passing them on to the respond() method. More...

void	onRead (yarp::os::Bottle &v) override
	Alternative handler for reading messages from the network, and passing them on to the respond() method. More...

void	makeUsage ()
	Regenerate usage information. More...

void	attach (yarp::os::TypedReader< yarp::os::Bottle > &source)
	Attach this object to a source of messages. More...

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor. More...

virtual bool	read (ConnectionReader &reader)=0
	Read this object from a network connection. More...

virtual Type	getReadType () const

Public Member Functions inherited from yarp::os::TypedReaderCallback< yarp::os::Bottle >
virtual	~TypedReaderCallback ()
	Destructor. More...

virtual void	onRead (yarp::os::Bottle &datum)
	Callback method. More...

virtual void	onRead (yarp::os::Bottle &datum, const yarp::os::TypedReader< yarp::os::Bottle > &reader)
	Callback method. More...

Detailed Description

A cheap and cheerful framework for human readable/writable forms of messages to devices.

The main concern is to makes it easier to document these messages. Override DeviceResponder::respond() to respond to new messages. You don't need to use this class – the network format of messages is defined independently of it.

Definition at line 149 of file DeviceDriver.h.

Constructor & Destructor Documentation

◆ DeviceResponder()

DeviceResponder::DeviceResponder ( )

Constructor.

Definition at line 48 of file DeviceDriver.cpp.

Member Function Documentation

◆ addUsage() [1/2]

void DeviceResponder::addUsage	(	const char *	txt,
		const char *	explain = `nullptr`
	)

Add information about a message that the respond() method understands.

Parameters

txt	the message, in text form
explain	an (optional) what the message means

Definition at line 52 of file DeviceDriver.cpp.

◆ addUsage() [2/2]

void DeviceResponder::addUsage	(	const yarp::os::Bottle &	bot,
		const char *	explain = `nullptr`
	)

Add information about a message that the respond() method understands.

Parameters

bot	the message, in bottle form
explain	an (optional) what the message means

Definition at line 61 of file DeviceDriver.cpp.

◆ attach()

void yarp::dev::DeviceResponder::attach ( yarp::os::TypedReader< yarp::os::Bottle > & source )

inline

Attach this object to a source of messages.

Parameters

source a BufferedPort or PortReaderBuffer that receives data.

Definition at line 219 of file DeviceDriver.h.

◆ makeUsage()

void DeviceResponder::makeUsage ( )

Regenerate usage information.

Definition at line 130 of file DeviceDriver.cpp.

◆ onRead()

void yarp::dev::DeviceResponder::onRead ( yarp::os::Bottle & v )

inlineoverridevirtual

Alternative handler for reading messages from the network, and passing them on to the respond() method.

There can be no replies made if this handler is used.

Parameters

v	the message

Reimplemented from yarp::os::TypedReaderCallback< yarp::os::Bottle >.

Definition at line 204 of file DeviceDriver.h.

◆ read()

bool DeviceResponder::read ( yarp::os::ConnectionReader & connection )

overridevirtual

Handler for reading messages from the network, and passing them on to the respond() method.

Parameters

connection a network connection to a port

Returns: true if the message was read successfully

Implements yarp::os::PortReader.

Definition at line 89 of file DeviceDriver.cpp.

◆ respond()

bool DeviceResponder::respond	(	const yarp::os::Bottle &	command,
		yarp::os::Bottle &	reply
	)

virtual

Respond to a message.

Parameters

command	the message
reply	the response

Returns: true if there was no critical failure

Reimplemented in RPCMessagesParser, yarp::proto::framegrabber::DepthVisualParams_Responder, yarp::proto::framegrabber::FrameGrabberControls_Responder, yarp::proto::framegrabber::FrameGrabberControlsDC1394_Responder, yarp::proto::framegrabber::FrameGrabberOf_Responder< ImageType, IfVocab, ImgVocab >, yarp::proto::framegrabber::FrameGrabberOf_Responder< yarp::sig::ImageOf< yarp::sig::PixelRgb > >, yarp::proto::framegrabber::FrameGrabberOf_Responder< yarp::sig::ImageOf< yarp::sig::PixelMono >, VOCAB_FRAMEGRABBER_IMAGERAW >, yarp::proto::framegrabber::RgbVisualParams_Responder, JoypadCtrlParser, RGBDImpl::RGBDSensorParser, RGBDImpl::RGBDSensorParser, FrameGrabber_nws_yarp, and ServerGrabberResponder.

Definition at line 66 of file DeviceDriver.cpp.

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

src/libYARP_dev/src/yarp/dev/DeviceDriver.h
src/libYARP_dev/src/yarp/dev/DeviceDriver.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DeviceResponder()

Member Function Documentation

◆ addUsage() [1/2]

◆ addUsage() [2/2]

◆ attach()

◆ makeUsage()

◆ onRead()

◆ read()

◆ respond()