fsrobo_r_driver::simple_message::simple_string::SimpleString Class Reference

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

#include <simple_string.h>

Inheritance diagram for fsrobo_r_driver::simple_message::simple_string::SimpleString:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (SimpleString &src)
	Copies the passed in value. More...
string	getString () const
	Returns the string data. More...
industrial::shared_types::shared_int	getStringSize () const
	Returns the string size. More...
void	init ()
	Initializes a empty motion control reply. More...
void	init (string str)
	Initializes a complete read single io reply. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (SimpleString &rhs)
	== operator implementation More...
void	setString (string str)
	Sets the string data. More...
	SimpleString (void)
	Default constructor. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	~SimpleString (void)
	Destructor. More...

Private Attributes
string	string_
	string data More...
industrial::shared_types::shared_int	string_size_
	string size 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 61 of file simple_string.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::simple_string::SimpleString::SimpleString

(

void

)

Default constructor.

This method creates empty data.

Definition at line 43 of file simple_string.cpp.

fsrobo_r_driver::simple_message::simple_string::SimpleString::~SimpleString

(

void

)

Destructor.

Definition at line 48 of file simple_string.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::simple_string::SimpleString::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 139 of file simple_string.h.

void fsrobo_r_driver::simple_message::simple_string::SimpleString::copyFrom

(

SimpleString &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 62 of file simple_string.cpp.

string fsrobo_r_driver::simple_message::simple_string::SimpleString::getString ( ) const

inline

Returns the string data.

Returns

string data

Definition at line 116 of file simple_string.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::simple_string::SimpleString::getStringSize ( ) const

inline

Returns the string size.

Returns

string size

Definition at line 106 of file simple_string.h.

void fsrobo_r_driver::simple_message::simple_string::SimpleString::init

(

)

Initializes a empty motion control reply.

Definition at line 52 of file simple_string.cpp.

void fsrobo_r_driver::simple_message::simple_string::SimpleString::init

(

string

str

)

Initializes a complete read single io reply.

Definition at line 57 of file simple_string.cpp.

bool fsrobo_r_driver::simple_message::simple_string::SimpleString::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 74 of file simple_string.cpp.

bool fsrobo_r_driver::simple_message::simple_string::SimpleString::operator==

(

SimpleString &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 67 of file simple_string.cpp.

void fsrobo_r_driver::simple_message::simple_string::SimpleString::setString ( string  str )

inline

Sets the string data.

Parameters

string

data

Definition at line 95 of file simple_string.h.

bool fsrobo_r_driver::simple_message::simple_string::SimpleString::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 101 of file simple_string.cpp.

Member Data Documentation

string fsrobo_r_driver::simple_message::simple_string::SimpleString::string_

private

string data

Definition at line 152 of file simple_string.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::simple_string::SimpleString::string_size_

private

string size

Definition at line 148 of file simple_string.h.

---

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

• simple_string.h
• simple_string.cpp