Message interface for typed messages built from simple_message(link) More...
#include <typed_message.h>
Public Member Functions | |
| int | getMessageType () const |
| gets message type (enumeration) | |
| virtual bool | init (industrial::simple_message::SimpleMessage &msg)=0 |
| Initializes message from a simple message. | |
| virtual void | init ()=0 |
| Initializes a new empty message. | |
| virtual bool | toReply (industrial::simple_message::SimpleMessage &msg, industrial::simple_message::ReplyType reply) |
| creates a simple_message reply | |
| virtual bool | toRequest (industrial::simple_message::SimpleMessage &msg) |
| creates a simple_message request | |
| virtual bool | toTopic (industrial::simple_message::SimpleMessage &msg) |
| creates a simple_message topic | |
Protected Member Functions | |
| void | setMessageType (int MESSAGE_TYPE=industrial::simple_message::StandardMsgTypes::INVALID) |
Private Attributes | |
| int | message_type_ |
| Message type expected by callback. | |
Detailed Description
Message interface for typed messages built from simple_message(link)
THIS CLASS IS NOT THREAD-SAFE
Definition at line 65 of file typed_message.h.
Member Function Documentation
| int industrial::typed_message::TypedMessage::getMessageType | ( | ) | const [inline] |
gets message type (enumeration)
- Returns:
- message type
Definition at line 133 of file typed_message.h.
| virtual bool industrial::typed_message::TypedMessage::init | ( | industrial::simple_message::SimpleMessage & | msg | ) | [pure virtual] |
Initializes message from a simple message.
- Returns:
- true if message successfully initialized, otherwise false
Implemented in industrial::joint_message::JointMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.
| virtual void industrial::typed_message::TypedMessage::init | ( | ) | [pure virtual] |
Initializes a new empty message.
Implemented in industrial::joint_message::JointMessage, industrial::joint_traj_pt_message::JointTrajPtMessage, and industrial::ping_message::PingMessage.
| void industrial::typed_message::TypedMessage::setMessageType | ( | int | MESSAGE_TYPE = industrial::simple_message::StandardMsgTypes::INVALID | ) | [inline, protected] |
Definition at line 141 of file typed_message.h.
| virtual bool industrial::typed_message::TypedMessage::toReply | ( | industrial::simple_message::SimpleMessage & | msg, |
| industrial::simple_message::ReplyType | reply | ||
| ) | [inline, virtual] |
creates a simple_message reply
- Returns:
- true if message successfully initialized, otherwise false
Definition at line 106 of file typed_message.h.
| virtual bool industrial::typed_message::TypedMessage::toRequest | ( | industrial::simple_message::SimpleMessage & | msg | ) | [inline, virtual] |
creates a simple_message request
- Returns:
- true if message successfully initialized, otherwise false
Definition at line 92 of file typed_message.h.
| virtual bool industrial::typed_message::TypedMessage::toTopic | ( | industrial::simple_message::SimpleMessage & | msg | ) | [inline, virtual] |
creates a simple_message topic
- Returns:
- true if message successfully initialized, otherwise false
Reimplemented in industrial::ping_message::PingMessage.
Definition at line 120 of file typed_message.h.
Member Data Documentation
int industrial::typed_message::TypedMessage::message_type_ [private] |
Message type expected by callback.
Definition at line 152 of file typed_message.h.
The documentation for this class was generated from the following file: