fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset Class Reference

Class encapsulated tool offset data. FSRobo-R specific interface to set tool offset on the controller. More...

#include <set_tool_offset.h>

Inheritance diagram for fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (SetToolOffset &src)
	Copies the passed in value. More...
industrial::shared_types::shared_real	getRx ()
	Returns offset. More...
industrial::shared_types::shared_real	getRy ()
	Returns offset. More...
industrial::shared_types::shared_real	getRz ()
	Returns offset. More...
industrial::shared_types::shared_real	getX ()
	Returns offset. More...
industrial::shared_types::shared_real	getY ()
	Returns offset. More...
industrial::shared_types::shared_real	getZ ()
	Returns offset. More...
void	init ()
	Initializes a empty set tool offset command. More...
void	init (industrial::shared_types::shared_real x, industrial::shared_types::shared_real y, industrial::shared_types::shared_real z, industrial::shared_types::shared_real rz, industrial::shared_types::shared_real ry, industrial::shared_types::shared_real rx)
	Initializes a complete set tool offset command. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (SetToolOffset &rhs)
	== operator implementation More...
void	setRx (industrial::shared_types::shared_real rx)
	Sets offset. More...
void	setRy (industrial::shared_types::shared_real ry)
	Sets offset. More...
void	setRz (industrial::shared_types::shared_real rz)
	Sets offset. More...
	SetToolOffset (void)
	Default constructor. More...
void	setX (industrial::shared_types::shared_real x)
	Sets offset. More...
void	setY (industrial::shared_types::shared_real y)
	Sets offset. More...
void	setZ (industrial::shared_types::shared_real z)
	Sets offset. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	~SetToolOffset (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_real	rx_
industrial::shared_types::shared_real	ry_
industrial::shared_types::shared_real	rz_
industrial::shared_types::shared_real	x_
	Values of tool origin. More...
industrial::shared_types::shared_real	y_
industrial::shared_types::shared_real	z_

Detailed Description

Class encapsulated tool offset data. FSRobo-R specific interface to set tool offset 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_tool_offset.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::SetToolOffset

(

void

)

Default constructor.

This method creates empty data.

Definition at line 42 of file set_tool_offset.cpp.

fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::~SetToolOffset

(

void

)

Destructor.

Definition at line 47 of file set_tool_offset.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 231 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::copyFrom

(

SetToolOffset &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 66 of file set_tool_offset.cpp.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getRx ( )

inline

Returns offset.

Returns

offset

Definition at line 199 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getRy ( )

inline

Returns offset.

Returns

offset

Definition at line 209 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getRz ( )

inline

Returns offset.

Returns

offset

Definition at line 189 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getX ( )

inline

Returns offset.

Returns

offset

Definition at line 159 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getY ( )

inline

Returns offset.

Returns

offset

Definition at line 169 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::getZ ( )

inline

Returns offset.

Returns

offset

Definition at line 179 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::init

(

)

Initializes a empty set tool offset command.

Definition at line 51 of file set_tool_offset.cpp.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::init	(	industrial::shared_types::shared_real	x,
		industrial::shared_types::shared_real	y,
		industrial::shared_types::shared_real	z,
		industrial::shared_types::shared_real	rz,
		industrial::shared_types::shared_real	ry,
		industrial::shared_types::shared_real	rx
	)

Initializes a complete set tool offset command.

Definition at line 56 of file set_tool_offset.cpp.

bool fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 88 of file set_tool_offset.cpp.

bool fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::operator==

(

SetToolOffset &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 76 of file set_tool_offset.cpp.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setRx ( industrial::shared_types::shared_real  rx )

inline

Sets offset.

Parameters

rx

Definition at line 149 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setRy ( industrial::shared_types::shared_real  ry )

inline

Sets offset.

Parameters

ry

Definition at line 139 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setRz ( industrial::shared_types::shared_real  rz )

inline

Sets offset.

Parameters

rz

Definition at line 129 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setX ( industrial::shared_types::shared_real  x )

inline

Sets offset.

Parameters

x

Definition at line 99 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setY ( industrial::shared_types::shared_real  y )

inline

Sets offset.

Parameters

y

Definition at line 109 of file set_tool_offset.h.

void fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::setZ ( industrial::shared_types::shared_real  z )

inline

Sets offset.

Parameters

z

Definition at line 119 of file set_tool_offset.h.

bool fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 132 of file set_tool_offset.cpp.

Member Data Documentation

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::rx_

private

Definition at line 245 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::ry_

private

Definition at line 244 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::rz_

private

Definition at line 243 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::x_

private

Values of tool origin.

Definition at line 240 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::y_

private

Definition at line 241 of file set_tool_offset.h.

industrial::shared_types::shared_real fsrobo_r_driver::simple_message::set_tool_offset::SetToolOffset::z_

private

Definition at line 242 of file set_tool_offset.h.

---

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

• set_tool_offset.h
• set_tool_offset.cpp