Public Member Functions | Private Attributes | List of all members
fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply Class Reference

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

#include <sys_stat_reply.h>

Inheritance diagram for fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply:
Inheritance graph
[legend]

Public Member Functions

unsigned int byteLength ()
 
void copyFrom (SysStatReply &src)
 Copies the passed in value. More...
 
industrial::shared_types::shared_int getResult () const
 Returns the result data. More...
 
SysStatReplyType getStatType () const
 Returns the stat type. More...
 
void init ()
 Initializes a empty motion control reply. More...
 
void init (SysStatReplyType stat_type, industrial::shared_types::shared_int result)
 Initializes a complete read single io reply. More...
 
bool load (industrial::byte_array::ByteArray *buffer)
 
bool operator== (SysStatReply &rhs)
 == operator implementation More...
 
void setResult (industrial::shared_types::shared_int result)
 Sets the result data. More...
 
void setStatType (SysStatReplyType stat_type)
 Sets the result type. More...
 
 SysStatReply (void)
 Default constructor. More...
 
bool unload (industrial::byte_array::ByteArray *buffer)
 
 ~SysStatReply (void)
 Destructor. More...
 

Private Attributes

industrial::shared_types::shared_int result_
 The result value. More...
 
industrial::shared_types::shared_int stat_type_
 The stat type. 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 80 of file sys_stat_reply.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::SysStatReply ( void  )

Default constructor.

This method creates empty data.

Definition at line 45 of file sys_stat_reply.cpp.

fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::~SysStatReply ( void  )

Destructor.

Definition at line 50 of file sys_stat_reply.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::byteLength ( )
inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 166 of file sys_stat_reply.h.

void fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::copyFrom ( SysStatReply src)

Copies the passed in value.

Parameters
src(value to copy)

Definition at line 65 of file sys_stat_reply.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::getResult ( ) const
inline

Returns the result data.

Returns
result_ value

Definition at line 144 of file sys_stat_reply.h.

SysStatReplyType fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::getStatType ( ) const
inline

Returns the stat type.

Returns
stat_type_

Definition at line 134 of file sys_stat_reply.h.

void fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::init ( )

Initializes a empty motion control reply.

Definition at line 54 of file sys_stat_reply.cpp.

void fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::init ( SysStatReplyType  stat_type,
industrial::shared_types::shared_int  result 
)

Initializes a complete read single io reply.

Definition at line 59 of file sys_stat_reply.cpp.

bool fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::load ( industrial::byte_array::ByteArray buffer)
virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 78 of file sys_stat_reply.cpp.

bool fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::operator== ( SysStatReply rhs)

== operator implementation

Returns
true if equal

Definition at line 71 of file sys_stat_reply.cpp.

void fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::setResult ( industrial::shared_types::shared_int  result)
inline

Sets the result data.

Parameters
resultvalue

Definition at line 124 of file sys_stat_reply.h.

void fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::setStatType ( SysStatReplyType  stat_type)
inline

Sets the result type.

Parameters
resulttype

Definition at line 114 of file sys_stat_reply.h.

bool fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::unload ( industrial::byte_array::ByteArray buffer)
virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 92 of file sys_stat_reply.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::result_
private

The result value.

Definition at line 179 of file sys_stat_reply.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat_reply::SysStatReply::stat_type_
private

The stat type.

Definition at line 175 of file sys_stat_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