Class encapsulated ping message generation methods (either to or from a SimpleMessage type. More...
#include <ping_message.h>
Public Member Functions | |
| unsigned int | byteLength () |
| Virtual method returns the object size when packed into a ByteArray. | |
| bool | init (industrial::simple_message::SimpleMessage &msg) |
| Initializes message from a simple message. | |
| void | init () |
| Initializes a new ping message. | |
| bool | load (industrial::byte_array::ByteArray *buffer) |
| Virtual method for loading an object into a ByteArray. | |
| PingMessage (void) | |
| Default constructor. | |
| bool | toTopic (industrial::simple_message::SimpleMessage &msg) |
| The ping message overrides the base method toTopic to always return false. A ping cannot be sent as a topic. | |
| bool | unload (industrial::byte_array::ByteArray *buffer) |
| Virtual method for unloading an object from a ByteArray. | |
| ~PingMessage (void) | |
| Destructor. | |
Detailed Description
Class encapsulated ping message generation methods (either to or from a SimpleMessage type.
THIS CLASS IS NOT THREAD-SAFE
Definition at line 60 of file ping_message.h.
Constructor & Destructor Documentation
Default constructor.
This method creates an empty byte ping message.
Definition at line 50 of file ping_message.cpp.
Destructor.
Definition at line 55 of file ping_message.cpp.
Member Function Documentation
| unsigned int industrial::ping_message::PingMessage::byteLength | ( | ) | [inline, virtual] |
Virtual method returns the object size when packed into a ByteArray.
- Returns:
- object size (in bytes)
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 104 of file ping_message.h.
| bool industrial::ping_message::PingMessage::init | ( | industrial::simple_message::SimpleMessage & | msg | ) | [virtual] |
Initializes message from a simple message.
- Returns:
- true if message successfully initialized, otherwise false
Implements industrial::typed_message::TypedMessage.
Definition at line 61 of file ping_message.cpp.
| void industrial::ping_message::PingMessage::init | ( | ) | [virtual] |
Initializes a new ping message.
Implements industrial::typed_message::TypedMessage.
Definition at line 80 of file ping_message.cpp.
| bool industrial::ping_message::PingMessage::load | ( | industrial::byte_array::ByteArray * | buffer | ) | [inline, virtual] |
Virtual method for loading an object into a ByteArray.
This method should load all the required data to reconstruct the class object into the buffer
- Parameters:
-
buffer pointer to ByteArray
- Returns:
- true on success, false otherwise (buffer not large enough)
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 102 of file ping_message.h.
| bool industrial::ping_message::PingMessage::toTopic | ( | industrial::simple_message::SimpleMessage & | msg | ) | [inline, virtual] |
The ping message overrides the base method toTopic to always return false. A ping cannot be sent as a topic.
Reimplemented from industrial::typed_message::TypedMessage.
Definition at line 96 of file ping_message.h.
| bool industrial::ping_message::PingMessage::unload | ( | industrial::byte_array::ByteArray * | buffer | ) | [inline, virtual] |
Virtual method for unloading an object from a ByteArray.
This method should unload all the required data to reconstruct the class object (in place)
- Parameters:
-
buffer pointer to ByteArray
- Returns:
- true on success, false otherwise (buffer not large enough)
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 103 of file ping_message.h.
The documentation for this class was generated from the following files: