fsrobo_r_driver::simple_message::io_state_message::IOStateMessage Class Reference

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

#include <io_state_message.h>

Inheritance diagram for fsrobo_r_driver::simple_message::io_state_message::IOStateMessage:

Public Member Functions
unsigned int	byteLength ()
bool	init (industrial::simple_message::SimpleMessage &msg)
	Initializes message from a simple message. More...
void	init (fsrobo_r_driver::simple_message::io_state::IOState &state)
	Initializes message from a robot status structure. More...
void	init ()
	Initializes a new robot status message. More...
	IOStateMessage (void)
	Default constructor. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	unload (industrial::byte_array::ByteArray *buffer)
	~IOStateMessage (void)
	Destructor. More...
Public Member Functions inherited from industrial::typed_message::TypedMessage
int	getCommType () const
int	getMessageType () const
virtual bool	toReply (industrial::simple_message::SimpleMessage &msg, industrial::simple_message::ReplyType reply)
virtual bool	toRequest (industrial::simple_message::SimpleMessage &msg)
virtual bool	toTopic (industrial::simple_message::SimpleMessage &msg)

Public Attributes
fsrobo_r_driver::simple_message::io_state::IOState	state_

Additional Inherited Members
Protected Member Functions inherited from industrial::typed_message::TypedMessage
void	setCommType (int comm_type=industrial::simple_message::CommTypes::INVALID)
void	setMessageType (int message_type=industrial::simple_message::StandardMsgTypes::INVALID)

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 56 of file io_state_message.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::IOStateMessage

(

void

)

Default constructor.

This method creates an empty message.

Definition at line 45 of file io_state_message.cpp.

fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::~IOStateMessage

(

void

)

Destructor.

Definition at line 50 of file io_state_message.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 101 of file io_state_message.h.

bool fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::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 55 of file io_state_message.cpp.

void fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::init

(

fsrobo_r_driver::simple_message::io_state::IOState &

state

)

Initializes message from a robot status structure.

Parameters

status

strcutre to initialize from

Definition at line 73 of file io_state_message.cpp.

void fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::init ( )

virtual

Initializes a new robot status message.

Implements industrial::typed_message::TypedMessage.

Definition at line 79 of file io_state_message.cpp.

bool fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 85 of file io_state_message.cpp.

bool fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 101 of file io_state_message.cpp.

Member Data Documentation

fsrobo_r_driver::simple_message::io_state::IOState fsrobo_r_driver::simple_message::io_state_message::IOStateMessage::state_

Definition at line 106 of file io_state_message.h.

---

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

• io_state_message.h
• io_state_message.cpp