Public Member Functions | Private Attributes | List of all members
fsrobo_r_driver::simple_message::io_control_reply::SetIOReply Class Reference

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

#include <set_io_reply.h>

Inheritance diagram for fsrobo_r_driver::simple_message::io_control_reply::SetIOReply:
Inheritance graph
[legend]

Public Member Functions

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

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::SetIOReply ( void  )

Default constructor.

This method creates empty data.

Definition at line 45 of file set_io_reply.cpp.

fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::~SetIOReply ( void  )

Destructor.

Definition at line 50 of file set_io_reply.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::byteLength ( )
inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 139 of file set_io_reply.h.

void fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::copyFrom ( SetIOReply src)

Copies the passed in value.

Parameters
src(value to copy)

Definition at line 65 of file set_io_reply.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::getResultCode ( ) const
inline

Returns the result code.

Returns
result_code number

Definition at line 117 of file set_io_reply.h.

void fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::init ( )

Initializes a empty motion control reply.

Definition at line 54 of file set_io_reply.cpp.

void fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::init ( SetIOReplyResult  result_code)

Initializes a complete read single io reply.

Definition at line 60 of file set_io_reply.cpp.

bool fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::load ( industrial::byte_array::ByteArray buffer)
virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 77 of file set_io_reply.cpp.

bool fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::operator== ( SetIOReply rhs)

== operator implementation

Returns
true if equal

Definition at line 70 of file set_io_reply.cpp.

void fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::setResultCode ( industrial::shared_types::shared_int  result_code)
inline

Sets the result code.

Parameters
resultcode

Definition at line 107 of file set_io_reply.h.

bool fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::unload ( industrial::byte_array::ByteArray buffer)
virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 91 of file set_io_reply.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control_reply::SetIOReply::result_code_
private

The result code.

Definition at line 148 of file set_io_reply.h.


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


fsrobo_r_driver
Author(s): F-ROSROBO
autogenerated on Sun Feb 9 2020 03:58:29