Class encapsulated read single io reply data. These messages are sent by the FS100 controller in response to ReadSingleIO messages. More...

#include <motoman_read_single_io_reply.h>

Inheritance diagram for motoman::simple_message::io_ctrl_reply::ReadSingleIOReply:

[legend]

List of all members.

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (ReadSingleIOReply &src)
	Copies the passed in value.
industrial::shared_types::shared_int	getResultCode () const
	Returns the result code.
std::string	getResultString () const
industrial::shared_types::shared_int	getValue () const
	Returns the value.
void	init ()
	Initializes a empty motion control reply.
void	init (industrial::shared_types::shared_int value, ReadSingleIOReplyResult result_code)
	Initializes a complete read single io reply.
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (ReadSingleIOReply &rhs)
	== operator implementation
	ReadSingleIOReply (void)
	Default constructor.
void	setResultCode (industrial::shared_types::shared_int result_code)
	Sets the result code.
void	setValue (industrial::shared_types::shared_int value)
	Sets value.
bool	unload (industrial::byte_array::ByteArray *buffer)
	~ReadSingleIOReply (void)
	Destructor.
Static Public Member Functions
static std::string	getResultString (industrial::shared_types::shared_int code)
Private Attributes
industrial::shared_types::shared_int	result_code_
	The result code.
industrial::shared_types::shared_int	value_
	The value.

Detailed Description

Class encapsulated read single io reply data. These messages are sent by the FS100 controller in response to ReadSingleIO messages.

The byte representation of a read single io reply is as follows (in order lowest index to highest). The standard sizes are given, but can change based on type sizes:

member: type size value (industrial::shared_types::shared_int) 4 bytes result_code (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 87 of file motoman_read_single_io_reply.h.

Constructor & Destructor Documentation

motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::ReadSingleIOReply ( void )

Default constructor.

This method creates empty data.

Definition at line 59 of file motoman_read_single_io_reply.cpp.

motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::~ReadSingleIOReply ( void )

Destructor.

Definition at line 63 of file motoman_read_single_io_reply.cpp.

Member Function Documentation

unsigned int motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::byteLength ( ) [inline, virtual]

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 185 of file motoman_read_single_io_reply.h.

void motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::copyFrom ( ReadSingleIOReply & src )

Copies the passed in value.

Parameters:

src	(value to copy)

Definition at line 92 of file motoman_read_single_io_reply.cpp.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::getResultCode ( ) const [inline]

Returns the result code.

Returns:: result_code number

Definition at line 151 of file motoman_read_single_io_reply.h.

std::string motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::getResultString ( industrial::shared_types::shared_int code ) [static]

Definition at line 79 of file motoman_read_single_io_reply.cpp.

std::string motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::getResultString ( ) const [inline]

Definition at line 162 of file motoman_read_single_io_reply.h.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::getValue ( ) const [inline]

Returns the value.

Returns:: value

Definition at line 131 of file motoman_read_single_io_reply.h.

void motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::init ( )

Initializes a empty motion control reply.

Definition at line 67 of file motoman_read_single_io_reply.cpp.

void motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::init	(	industrial::shared_types::shared_int	value,
		ReadSingleIOReplyResult	result_code
	)