motoman::simple_message::io_ctrl_reply::ReadSingleIOReply Class Reference

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:

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

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. More...
industrial::shared_types::shared_int	value_
	The value. More...

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 91 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 ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 189 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 105 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 155 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 166 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 135 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,
		ReadSingleIOReplyResultCode	result_code
	)

Initializes a complete read single io reply.

Definition at line 73 of file motoman_read_single_io_reply.cpp.

bool motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 119 of file motoman_read_single_io_reply.cpp.

bool motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::operator==

(

ReadSingleIOReply &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 111 of file motoman_read_single_io_reply.cpp.

void motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::setResultCode ( industrial::shared_types::shared_int  result_code )

inline

Sets the result code.

Parameters

result

code

Definition at line 145 of file motoman_read_single_io_reply.h.

void motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::setValue ( industrial::shared_types::shared_int  value )

inline

Sets value.

Parameters

value

The value

Definition at line 125 of file motoman_read_single_io_reply.h.

bool motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 139 of file motoman_read_single_io_reply.cpp.

Member Data Documentation

industrial::shared_types::shared_int motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::result_code_

private

The result code.

Definition at line 203 of file motoman_read_single_io_reply.h.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl_reply::ReadSingleIOReply::value_

private

The value.

Definition at line 198 of file motoman_read_single_io_reply.h.

---

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

• motoman_read_single_io_reply.h
• motoman_read_single_io_reply.cpp