fsrobo_r_driver::simple_message::io_control::SetIO Class Reference

Class encapsulated write single io data. FSRobo-R specific interface to set IO element on the controller. More...

#include <set_io.h>

Inheritance diagram for fsrobo_r_driver::simple_message::io_control::SetIO:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (SetIO &src)
	Copies the passed in value. More...
industrial::shared_types::shared_int	getAddress ()
	Returns the address of the IO element. More...
industrial::shared_types::shared_int *	getData ()
	Returns the value of the IO element. More...
industrial::shared_types::shared_int	getDataSize ()
	Returns the value of the IO element. More...
industrial::shared_types::shared_int	getFun ()
	Returns the value of the IO element. More...
void	init ()
	Initializes a empty write single io command. More...
void	init (industrial::shared_types::shared_int fun, industrial::shared_types::shared_int address, std::vector< industrial::shared_types::shared_int > &data)
	Initializes a complete write single io command. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (SetIO &rhs)
	== operator implementation More...
void	setAddress (industrial::shared_types::shared_int address)
	Sets address. More...
void	setDataSize (industrial::shared_types::shared_int data_size)
	Sets value. More...
void	setFun (industrial::shared_types::shared_int fun)
	Sets value. More...
	SetIO (void)
	Default constructor. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	~SetIO (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_int	address_
	Address of IO element. More...
industrial::shared_types::shared_int	data_ [32]
industrial::shared_types::shared_int	data_size_
industrial::shared_types::shared_int	fun_
	Value of IO element. More...

Detailed Description

Class encapsulated write single io data. FSRobo-R specific interface to set IO element on the controller.

The byte representation of a write single IO command is as follows (in order lowest index to highest). The standard sizes are given, but can change based on type sizes:

member: type size address (industrial::shared_types::shared_int) 4 bytes value (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 60 of file set_io.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::io_control::SetIO::SetIO

(

void

)

Default constructor.

This method creates empty data.

Definition at line 44 of file set_io.cpp.

fsrobo_r_driver::simple_message::io_control::SetIO::~SetIO

(

void

)

Destructor.

Definition at line 49 of file set_io.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::io_control::SetIO::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 176 of file set_io.h.

void fsrobo_r_driver::simple_message::io_control::SetIO::copyFrom

(

SetIO &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 79 of file set_io.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::getAddress ( )

inline

Returns the address of the IO element.

Returns

address

Definition at line 124 of file set_io.h.

industrial::shared_types::shared_int* fsrobo_r_driver::simple_message::io_control::SetIO::getData ( )

inline

Returns the value of the IO element.

Returns

value

Definition at line 154 of file set_io.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::getDataSize ( )

inline

Returns the value of the IO element.

Returns

value

Definition at line 144 of file set_io.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::getFun ( )

inline

Returns the value of the IO element.

Returns

value

Definition at line 134 of file set_io.h.

void fsrobo_r_driver::simple_message::io_control::SetIO::init

(

)

Initializes a empty write single io command.

Definition at line 53 of file set_io.cpp.

void fsrobo_r_driver::simple_message::io_control::SetIO::init	(	industrial::shared_types::shared_int	fun,
		industrial::shared_types::shared_int	address,
		std::vector< industrial::shared_types::shared_int > &	data
	)

Initializes a complete write single io command.

bool fsrobo_r_driver::simple_message::io_control::SetIO::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 101 of file set_io.cpp.

bool fsrobo_r_driver::simple_message::io_control::SetIO::operator==

(

SetIO &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 92 of file set_io.cpp.

void fsrobo_r_driver::simple_message::io_control::SetIO::setAddress ( industrial::shared_types::shared_int  address )

inline

Sets address.

Parameters

address

Controller address of the targeted IO element.

Definition at line 94 of file set_io.h.

void fsrobo_r_driver::simple_message::io_control::SetIO::setDataSize ( industrial::shared_types::shared_int  data_size )

inline

Sets value.

Parameters

value

Controller value of the targeted IO element.

Definition at line 114 of file set_io.h.

void fsrobo_r_driver::simple_message::io_control::SetIO::setFun ( industrial::shared_types::shared_int  fun )

inline

Sets value.

Parameters

value

Controller value of the targeted IO element.

Definition at line 104 of file set_io.h.

bool fsrobo_r_driver::simple_message::io_control::SetIO::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 136 of file set_io.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::address_

private

Address of IO element.

Definition at line 190 of file set_io.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::data_[32]

private

Definition at line 193 of file set_io.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::data_size_

private

Definition at line 192 of file set_io.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_control::SetIO::fun_

private

Value of IO element.

Definition at line 185 of file set_io.h.

---

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

• set_io.h
• set_io.cpp