rovsoft::io::NConfirmedCommandSender Class Reference

Command sender devices (Type: 0x00 (see Devices document)), are represented in software by objects of this class. More...

#include <NConfirmedCommandSender.hh>

Inheritance diagram for rovsoft::io::NConfirmedCommandSender:

[legend]Collaboration diagram for rovsoft::io::NConfirmedCommandSender:

[legend]List of all members.

Public Member Functions
	NConfirmedCommandSender (messages::MessageReceiver *out=0)
virtual void	parseMessageStream (unsigned short sa, unsigned short da, IStreamer &stream, messages::MessageReceiver *out=0) throw (lib::ExceptionPtr)
	This method tries to read the data part of a message from the stream specified by stream.
virtual void	setNMotionCommandReceiver (messages::NMotionCommandMessageReceiver &listener)
	Use this method to set a listener to which this object will send numbered motion command messages.
virtual void	setNBoolCommandReceiver (messages::NBoolCommandMessageReceiver &listener)
	Use this method to set a listener to which this object will send numbered bool command messages.
virtual void	putNConfirmationMessage (messages::NConfirmationMessagePtr message)
	Use this method to confirm a command.
Static Public Attributes
static const unsigned short	type = 0x0000
	The command sender type.

---

Detailed Description

Command sender devices (Type: 0x00 (see Devices document)), are represented in software by objects of this class.

This class can create messages from an IStreamer. The method parseMessageStream will block until at least one receiver is set.

Don't get confused with the messages::NConfirmedCommandMessageSender class, its the general interface for classes sending numbered confirmed command messages.

---

Constructor & Destructor Documentation

rovsoft::io::NConfirmedCommandSender::NConfirmedCommandSender (  messages::MessageReceiver *  out = 0  )  [inline]

---

Member Function Documentation

void rovsoft::io::NConfirmedCommandSender::parseMessageStream (  unsigned short  sa, unsigned short  da, IStreamer &  stream, messages::MessageReceiver *  out = 0 )  throw (lib::ExceptionPtr) [virtual]

This method tries to read the data part of a message from the stream specified by stream. Parameters: sa  The source address of the message being read. da  The destination address of the message being read. stream  The stream to read the data part of the message from. out  The messageReceiver that will be used for writing messages to the destination specified by sa! (reply) Exceptions: Exception  throws any exception that occur while reading from stream. Reimplemented from rovsoft::io::Receiver. Here is the call graph for this function:

void rovsoft::io::NConfirmedCommandSender::putNConfirmationMessage (  messages::NConfirmationMessagePtr  message  )  [virtual]

Use this method to confirm a command. Objects of this class want a confirmation for all the commands they have sent. Such a confirmation message must have a number equal to that of the command being confirmed and a status field. Implements rovsoft::messages::NConfirmationMessageReceiver. Here is the call graph for this function:

void rovsoft::io::NConfirmedCommandSender::setNBoolCommandReceiver (  messages::NBoolCommandMessageReceiver &  listener  )  [virtual]

Use this method to set a listener to which this object will send numbered bool command messages. Implements rovsoft::messages::NBoolCommandMessageSender. Here is the call graph for this function:

void rovsoft::io::NConfirmedCommandSender::setNMotionCommandReceiver (  messages::NMotionCommandMessageReceiver &  listener  )  [virtual]

Use this method to set a listener to which this object will send numbered motion command messages. Reimplemented from rovsoft::messages::NMotionCommandMessageSender. Here is the call graph for this function:

---

Member Data Documentation

const unsigned short rovsoft::io::NConfirmedCommandSender::type = 0x0000 [static]

The command sender type.

---

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

• NConfirmedCommandSender.hh
• NConfirmedCommandSender.cc

---