fsrobo_r_driver::simple_message::io_state::IOState Class Reference

Class encapsulated robot status data. The robot status data is meant to mirror the industrial_msgs/RobotStatus message. More...

#include <io_state.h>

Inheritance diagram for fsrobo_r_driver::simple_message::io_state::IOState:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (IOState &src)
	Copies the passed in value. More...
industrial::shared_types::shared_int	getAnalog (int idx)
industrial::shared_types::shared_int	getDigital (int idx)
	Initializes a full robot status message. More...
void	init ()
	Initializes an empty robot status. More...
	IOState (void)
	Default constructor. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (IOState &rhs)
	== operator implementation More...
void	setAnalog (int idx, industrial::shared_types::shared_int val)
void	setDigital (int idx, industrial::shared_types::shared_int val)
bool	unload (industrial::byte_array::ByteArray *buffer)
	~IOState (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_int	analog_ [1]
	Analog. More...
industrial::shared_types::shared_int	digital_ [2]
	Digital. More...

Detailed Description

Class encapsulated robot status data. The robot status data is meant to mirror the industrial_msgs/RobotStatus message.

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

member: type size drives_powered (industrial::shared_types::shared_int) 4 bytes e_stopped (industrial::shared_types::shared_int) 4 bytes error_code (industrial::shared_types::shared_int) 4 bytes in_error (industrial::shared_types::shared_int) 4 bytes in_motion (industrial::shared_types::shared_int) 4 bytes mode (industrial::shared_types::shared_int) 4 bytes motion_possible (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 70 of file io_state.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::io_state::IOState::IOState

(

void

)

Default constructor.

This method creates empty data.

Definition at line 42 of file io_state.cpp.

fsrobo_r_driver::simple_message::io_state::IOState::~IOState

(

void

)

Destructor.

Definition at line 47 of file io_state.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::io_state::IOState::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 137 of file io_state.h.

void fsrobo_r_driver::simple_message::io_state::IOState::copyFrom

(

IOState &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 59 of file io_state.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_state::IOState::getAnalog ( int  idx )

inline

Definition at line 105 of file io_state.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_state::IOState::getDigital ( int  idx )

inline

Initializes a full robot status message.

Definition at line 100 of file io_state.h.

void fsrobo_r_driver::simple_message::io_state::IOState::init

(

)

Initializes an empty robot status.

Definition at line 52 of file io_state.cpp.

bool fsrobo_r_driver::simple_message::io_state::IOState::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 72 of file io_state.cpp.

bool fsrobo_r_driver::simple_message::io_state::IOState::operator==

(

IOState &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 66 of file io_state.cpp.

void fsrobo_r_driver::simple_message::io_state::IOState::setAnalog ( int  idx, industrial::shared_types::shared_int  val  )

inline

Definition at line 115 of file io_state.h.

void fsrobo_r_driver::simple_message::io_state::IOState::setDigital ( int  idx, industrial::shared_types::shared_int  val  )

inline

Definition at line 110 of file io_state.h.

bool fsrobo_r_driver::simple_message::io_state::IOState::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 93 of file io_state.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_state::IOState::analog_[1]

private

Analog.

Definition at line 151 of file io_state.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::io_state::IOState::digital_[2]

private

Digital.

Definition at line 146 of file io_state.h.

---

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

• io_state.h
• io_state.cpp