LinearGotoKniMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::LinearGotoKniMessage:

Classes
struct	LinearGotoKniMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	LinearGotoKniMessage (const float ini_x, const float ini_y, const float ini_z, const float ini_phi, const float ini_theta, const float ini_psi)
	Constructor with initial values.
	LinearGotoKniMessage ()
	Constructor.
	~LinearGotoKniMessage ()
	Destructor.
	LinearGotoKniMessage (const LinearGotoKniMessage *m)
	Copy constructor.
float	x () const
	Get x value.
void	set_x (const float new_x)
	Set x value.
size_t	maxlenof_x () const
	Get maximum length of x value.
float	y () const
	Get y value.
void	set_y (const float new_y)
	Set y value.
size_t	maxlenof_y () const
	Get maximum length of y value.
float	z () const
	Get z value.
void	set_z (const float new_z)
	Set z value.
size_t	maxlenof_z () const
	Get maximum length of z value.
float	phi () const
	Get phi value.
void	set_phi (const float new_phi)
	Set phi value.
size_t	maxlenof_phi () const
	Get maximum length of phi value.
float	theta () const
	Get theta value.
void	set_theta (const float new_theta)
	Set theta value.
size_t	maxlenof_theta () const
	Get maximum length of theta value.
float	psi () const
	Get psi value.
void	set_psi (const float new_psi)
	Set psi value.
size_t	maxlenof_psi () const
	Get maximum length of psi value.
virtual Message *	clone () const
	Clone this message.
Public Member Functions inherited from fawkes::Message
	Message (const char *type)
	Constructor.
	Message (const Message *mesg)
	Copy constructor.
	Message (const Message &mesg)
	Copy constructor.
virtual	~Message ()
	Destructor.
Message &	operator= (const Message &m)
	Assign this message to given message.
unsigned int	id () const
	Get message ID.
void	set_id (unsigned int message_id)
	Set message ID.
void	mark_enqueued ()
	Mark message as being enqueued.
bool	enqueued () const
	Check is message has been enqueued.
const Time *	time_enqueued () const
	Get time when message was enqueued.
unsigned int	sender_id () const
	Get ID of sender.
const char *	sender_thread_name () const
	Get sender of message.
Interface *	interface () const
	Get transmitting interface.
const char *	type () const
	Get message type.
InterfaceFieldIterator	fields ()
	Get iterator over all fields of this interface instance.
InterfaceFieldIterator	fields_end ()
	Invalid iterator.
unsigned int	num_fields () const
	Get the number of fields in the message.
const void *	datachunk () const
	Get pointer to data.
unsigned int	datasize () const
	Get size of data.
unsigned int	hops () const
	Get number of hops.
void	set_hops (unsigned int hops)
	Set number of hops.
void	set_from_chunk (const void *chunk)
	Set from raw data chunk.
unsigned int	recipient () const
	Get recipient memory serial.
template<class MessageType >
bool	is_of_type ()
	Check if message has desired type.
Public Member Functions inherited from fawkes::RefCount
	RefCount ()
	Constructor.
virtual	~RefCount ()
	Destructor.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count and conditionally delete this instance.
unsigned int	refcount ()
	Get reference count for this instance.

Additional Inherited Members
Protected Member Functions inherited from fawkes::Message
void	add_fieldinfo (interface_fieldtype_t type, const char name, size_t length, void value, const char *enumtype=0)
	Add an entry to the info list.
Protected Attributes inherited from fawkes::Message
void *	data_ptr
	Pointer to memory that contains local data.
unsigned int	data_size
	Size of memory needed to hold all data.
message_data_ts_t *	data_ts
	data timestamp aliasing pointer

Detailed Description

LinearGotoKniMessage Fawkes BlackBoard Interface Message.

Definition at line 239 of file KatanaInterface.h.

Constructor & Destructor Documentation

fawkes::KatanaInterface::LinearGotoKniMessage::LinearGotoKniMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_z,
		const float	ini_phi,
		const float	ini_theta,
		const float	ini_psi
	)

Constructor with initial values.

Parameters:

ini_x	initial value for x
ini_y	initial value for y
ini_z	initial value for z
ini_phi	initial value for phi
ini_theta	initial value for theta
ini_psi	initial value for psi

Definition at line 1398 of file KatanaInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

fawkes::KatanaInterface::LinearGotoKniMessage::LinearGotoKniMessage ( )

Constructor.

Definition at line 1419 of file KatanaInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

fawkes::KatanaInterface::LinearGotoKniMessage::~LinearGotoKniMessage ( )

Destructor.

Definition at line 1435 of file KatanaInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::KatanaInterface::LinearGotoKniMessage::LinearGotoKniMessage ( const LinearGotoKniMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1443 of file KatanaInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

Message * fawkes::KatanaInterface::LinearGotoKniMessage::clone ( ) const

virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns:: clone of this message

Reimplemented from fawkes::Message.

Definition at line 1645 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_phi ( ) const

Get maximum length of phi value.

Returns:: length of phi value, can be length of the array or number of maximum number of characters for a string

Definition at line 1564 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_psi ( ) const

Get maximum length of psi value.

Returns:: length of psi value, can be length of the array or number of maximum number of characters for a string

Definition at line 1624 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_theta ( ) const

Get maximum length of theta value.

Returns:: length of theta value, can be length of the array or number of maximum number of characters for a string

Definition at line 1594 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_x ( ) const

Get maximum length of x value.

Returns:: length of x value, can be length of the array or number of maximum number of characters for a string

Definition at line 1469 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_y ( ) const

Get maximum length of y value.

Returns:: length of y value, can be length of the array or number of maximum number of characters for a string

Definition at line 1501 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::LinearGotoKniMessage::maxlenof_z ( ) const

Get maximum length of z value.

Returns:: length of z value, can be length of the array or number of maximum number of characters for a string

Definition at line 1533 of file KatanaInterface.cpp.

float fawkes::KatanaInterface::LinearGotoKniMessage::phi ( ) const

Get phi value.

Euler angle Phi of tool orientation.

Returns:: phi value

Definition at line 1554 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

float fawkes::KatanaInterface::LinearGotoKniMessage::psi ( ) const

Get psi value.

Euler angle Psi of tool orientation.

Returns:: psi value

Definition at line 1614 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

void fawkes::KatanaInterface::LinearGotoKniMessage::set_phi ( const float new_phi )

Set phi value.

Euler angle Phi of tool orientation.

Parameters:

new_phi new phi value

Definition at line 1574 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::LinearGotoKniMessage::set_psi ( const float new_psi )

Set psi value.

Euler angle Psi of tool orientation.

Parameters:

new_psi new psi value

Definition at line 1634 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::LinearGotoKniMessage::set_theta ( const float new_theta )

Set theta value.

Euler angle Theta of tool orientation.

Parameters:

new_theta new theta value

Definition at line 1604 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::LinearGotoKniMessage::set_x ( const float new_x )

Set x value.

X-Coordinate for tool position compared to base libkni coordinate system.

Parameters:

new_x new x value

Definition at line 1480 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::LinearGotoKniMessage::set_y ( const float new_y )

Set y value.

Y-Coordinate for tool position compared to base libkni coordinate system.

Parameters:

new_y new y value

Definition at line 1512 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::LinearGotoKniMessage::set_z ( const float new_z )

Set z value.

Z-Coordinate for tool position compared to base libkni coordinate system.

Parameters:

new_z new z value

Definition at line 1544 of file KatanaInterface.cpp.

float fawkes::KatanaInterface::LinearGotoKniMessage::theta ( ) const

Get theta value.

Euler angle Theta of tool orientation.

Returns:: theta value

Definition at line 1584 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

float fawkes::KatanaInterface::LinearGotoKniMessage::x ( ) const

Get x value.

X-Coordinate for tool position compared to base libkni coordinate system.

Returns:: x value

Definition at line 1459 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

float fawkes::KatanaInterface::LinearGotoKniMessage::y ( ) const

Get y value.

Y-Coordinate for tool position compared to base libkni coordinate system.

Returns:: y value

Definition at line 1491 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

float fawkes::KatanaInterface::LinearGotoKniMessage::z ( ) const

Get z value.

Z-Coordinate for tool position compared to base libkni coordinate system.

Returns:: z value

Definition at line 1523 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

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

src/libs/interfaces/KatanaInterface.h
src/plugins/katana/interfaces/KatanaInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation