Public Member Functions | Public Attributes
industrial::robot_status_message::RobotStatusMessage Class Reference

Class encapsulated robot status message generation methods (either to or from a industrial::simple_message::SimpleMessage type. More...

#include <robot_status_message.h>

Inheritance diagram for industrial::robot_status_message::RobotStatusMessage:
Inheritance graph
[legend]

List of all members.

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 (industrial::robot_status::RobotStatus &status)
 Initializes message from a robot status structure.
void init ()
 Initializes a new robot status message.
bool load (industrial::byte_array::ByteArray *buffer)
 Virtual method for loading an object into a ByteArray.
 RobotStatusMessage (void)
 Default constructor.
bool unload (industrial::byte_array::ByteArray *buffer)
 Virtual method for unloading an object from a ByteArray.
 ~RobotStatusMessage (void)
 Destructor.

Public Attributes

industrial::robot_status::RobotStatus status_

Detailed Description

Class encapsulated robot status message generation methods (either to or from a industrial::simple_message::SimpleMessage type.

This message simply wraps the industrial::robot_status::RobotStatus data type. The data portion of this typed message matches RobotStatus.

THIS CLASS IS NOT THREAD-SAFE

Definition at line 66 of file robot_status_message.h.


Constructor & Destructor Documentation

Default constructor.

This method creates an empty message.

Definition at line 54 of file robot_status_message.cpp.

Destructor.

Definition at line 59 of file robot_status_message.cpp.


Member Function Documentation

Virtual method returns the object size when packed into a ByteArray.

Returns:
object size (in bytes)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 109 of file robot_status_message.h.

Initializes message from a simple message.

Parameters:
simplemessage to construct from
Returns:
true if message successfully initialized, otherwise false

Implements industrial::typed_message::TypedMessage.

Definition at line 64 of file robot_status_message.cpp.

Initializes message from a robot status structure.

Parameters:
statusstrcutre to initialize from

Definition at line 82 of file robot_status_message.cpp.

Initializes a new robot status message.

Implements industrial::typed_message::TypedMessage.

Definition at line 88 of file robot_status_message.cpp.

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:
bufferpointer to ByteArray
Returns:
true on success, false otherwise (buffer not large enough)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 94 of file robot_status_message.cpp.

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:
bufferpointer to ByteArray
Returns:
true on success, false otherwise (buffer not large enough)

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 110 of file robot_status_message.cpp.


Member Data Documentation

Definition at line 115 of file robot_status_message.h.


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


simple_message
Author(s): Shaun Edwards
autogenerated on Tue Jan 17 2017 21:10:02