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:

[legend]

Public Member Functions
unsigned int	byteLength ()
	Virtual method returns the object size when packed into a ByteArray. More...

bool	init (industrial::simple_message::SimpleMessage &msg)
	Initializes message from a simple message. More...

void	init (industrial::robot_status::RobotStatus &status)
	Initializes message from a robot status structure. More...

void	init ()
	Initializes a new robot status message. More...

bool	load (industrial::byte_array::ByteArray *buffer)
	Virtual method for loading an object into a ByteArray. More...

	RobotStatusMessage (void)
	Default constructor. More...

bool	unload (industrial::byte_array::ByteArray *buffer)
	Virtual method for unloading an object from a ByteArray. More...

	~RobotStatusMessage (void)
	Destructor. More...

Public Member Functions inherited from industrial::typed_message::TypedMessage
int	getCommType () const
	Gets the communication type of the message. More...

int	getMessageType () const
	gets message type (enumeration) More...

virtual bool	toReply (industrial::simple_message::SimpleMessage &msg, industrial::simple_message::ReplyType reply)
	creates a simple_message reply More...

virtual bool	toRequest (industrial::simple_message::SimpleMessage &msg)
	creates a simple_message request More...

virtual bool	toTopic (industrial::simple_message::SimpleMessage &msg)
	creates a simple_message topic More...

Public Attributes
industrial::robot_status::RobotStatus	status_

Additional Inherited Members
Protected Member Functions inherited from industrial::typed_message::TypedMessage
void	setCommType (int comm_type=industrial::simple_message::CommTypes::INVALID)
	Sets the communication type of the message. More...

void	setMessageType (int message_type=industrial::simple_message::StandardMsgTypes::INVALID)
	sets message type More...

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

industrial::robot_status_message::RobotStatusMessage::RobotStatusMessage ( void )

Default constructor.

This method creates an empty message.

Definition at line 54 of file robot_status_message.cpp.

industrial::robot_status_message::RobotStatusMessage::~RobotStatusMessage ( void )

Destructor.

Definition at line 59 of file robot_status_message.cpp.

Member Function Documentation

unsigned int industrial::robot_status_message::RobotStatusMessage::byteLength ( )

inlinevirtual

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.

bool industrial::robot_status_message::RobotStatusMessage::init ( industrial::simple_message::SimpleMessage & msg )

virtual

Initializes message from a simple message.

Parameters

simple message 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.

void industrial::robot_status_message::RobotStatusMessage::init ( industrial::robot_status::RobotStatus & status )

Initializes message from a robot status structure.

Parameters

status strcutre to initialize from

Definition at line 82 of file robot_status_message.cpp.

void industrial::robot_status_message::RobotStatusMessage::init ( )

virtual

Initializes a new robot status message.

Implements industrial::typed_message::TypedMessage.

Definition at line 88 of file robot_status_message.cpp.

bool industrial::robot_status_message::RobotStatusMessage::load ( industrial::byte_array::ByteArray * buffer )

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 94 of file robot_status_message.cpp.

bool industrial::robot_status_message::RobotStatusMessage::unload ( industrial::byte_array::ByteArray * buffer )

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 110 of file robot_status_message.cpp.

Member Data Documentation

industrial::robot_status::RobotStatus industrial::robot_status_message::RobotStatusMessage::status_

Definition at line 115 of file robot_status_message.h.

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation