fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply Class Reference

Class encapsulated set io reply data. These messages are sent by the FSRobo-R controller in response to ExecuteProgram messages. More...

#include <execute_program_reply.h>

Inheritance diagram for fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (ExecuteProgramReply &src)
	Copies the passed in value. More...
	ExecuteProgramReply (void)
	Default constructor. More...
industrial::shared_types::shared_int	getResultCode () const
	Returns the result code. More...
void	init ()
	Initializes a empty motion control reply. More...
void	init (ExecuteProgramReplyResult result_code)
	Initializes a complete execute program reply. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (ExecuteProgramReply &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)
	~ExecuteProgramReply (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_int	result_code_
	The result code. More...

Detailed Description

Class encapsulated set io reply data. These messages are sent by the FSRobo-R controller in response to ExecuteProgram messages.

The byte representation of a set 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 73 of file execute_program_reply.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::ExecuteProgramReply

(

void

)

Default constructor.

This method creates empty data.

Definition at line 44 of file execute_program_reply.cpp.

fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::~ExecuteProgramReply

(

void

)

Destructor.

Definition at line 49 of file execute_program_reply.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 139 of file execute_program_reply.h.

void fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::copyFrom

(

ExecuteProgramReply &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 63 of file execute_program_reply.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::getResultCode ( ) const

inline

Returns the result code.

Returns

result_code number

Definition at line 117 of file execute_program_reply.h.

void fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::init

(

)

Initializes a empty motion control reply.

Definition at line 53 of file execute_program_reply.cpp.

void fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::init

(

ExecuteProgramReplyResult

result_code

)

Initializes a complete execute program reply.

Definition at line 58 of file execute_program_reply.cpp.

bool fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 75 of file execute_program_reply.cpp.

bool fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::operator==

(

ExecuteProgramReply &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 68 of file execute_program_reply.cpp.

void fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::setResultCode ( industrial::shared_types::shared_int  result_code )

inline

Sets the result code.

Parameters

result

code

Definition at line 107 of file execute_program_reply.h.

bool fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 89 of file execute_program_reply.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::execute_program_reply::ExecuteProgramReply::result_code_

private

The result code.

Definition at line 148 of file execute_program_reply.h.

---

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

• execute_program_reply.h
• execute_program_reply.cpp