motoman::simple_message::io_ctrl_reply::WriteSingleIOReply Class Reference

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

#include <motoman_write_single_io_reply.h>

Inheritance diagram for motoman::simple_message::io_ctrl_reply::WriteSingleIOReply:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (WriteSingleIOReply &src)
	Copies the passed in value. More...
industrial::shared_types::shared_int	getResultCode () const
	Returns the result code. More...
std::string	getResultString () const
void	init ()
	Initializes a empty motion control reply. More...
void	init (WriteSingleIOReplyResultCode result_code)
	Initializes a complete read single io reply. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (WriteSingleIOReply &rhs)
	== operator implementation More...
void	setResultCode (industrial::shared_types::shared_int result_code)
	Sets the result code. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	WriteSingleIOReply (void)
	Default constructor. More...
	~WriteSingleIOReply (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...

Detailed Description

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

The byte representation of a write 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 result_code (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 90 of file motoman_write_single_io_reply.h.

Constructor & Destructor Documentation

motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::WriteSingleIOReply

(

void

)

Default constructor.

This method creates empty data.

Definition at line 59 of file motoman_write_single_io_reply.cpp.

motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::~WriteSingleIOReply

(

void

)

Destructor.

Definition at line 63 of file motoman_write_single_io_reply.cpp.

Member Function Documentation

unsigned int motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 167 of file motoman_write_single_io_reply.h.

void motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::copyFrom

(

WriteSingleIOReply &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 104 of file motoman_write_single_io_reply.cpp.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::getResultCode ( ) const

inline

Returns the result code.

Returns

result_code number

Definition at line 133 of file motoman_write_single_io_reply.h.

std::string motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::getResultString ( industrial::shared_types::shared_int  code )

static

Definition at line 78 of file motoman_write_single_io_reply.cpp.

std::string motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::getResultString ( ) const

inline

Definition at line 144 of file motoman_write_single_io_reply.h.

void motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::init

(

)

Initializes a empty motion control reply.

Definition at line 67 of file motoman_write_single_io_reply.cpp.

void motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::init

(

WriteSingleIOReplyResultCode

result_code

)

Initializes a complete read single io reply.

Definition at line 73 of file motoman_write_single_io_reply.cpp.

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

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 116 of file motoman_write_single_io_reply.cpp.

bool motoman::simple_message::io_ctrl_reply::WriteSingleIOReply::operator==

(

WriteSingleIOReply &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 109 of file motoman_write_single_io_reply.cpp.

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

inline

Sets the result code.

Parameters

result

code

Definition at line 123 of file motoman_write_single_io_reply.h.

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

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 130 of file motoman_write_single_io_reply.cpp.

Member Data Documentation

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

private

The result code.

Definition at line 176 of file motoman_write_single_io_reply.h.

---

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

• motoman_write_single_io_reply.h
• motoman_write_single_io_reply.cpp