fawkes::KickerInterface::KickMessage Class Reference

KickMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KickerInterface.h>

Inheritance diagram for fawkes::KickerInterface::KickMessage:

Classes
struct	KickMessage_data_t
	Internal data storage, do NOT modify!
Public Member Functions
	KickMessage (const bool ini_left, const bool ini_center, const bool ini_right, const uint32_t ini_intensity)
	Constructor with initial values.
	KickMessage ()
	Constructor.
	~KickMessage ()
	Destructor.
	KickMessage (const KickMessage *m)
	Copy constructor.
bool	is_left () const
	Get left value.
void	set_left (const bool new_left)
	Set left value.
size_t	maxlenof_left () const
	Get maximum length of left value.
bool	is_center () const
	Get center value.
void	set_center (const bool new_center)
	Set center value.
size_t	maxlenof_center () const
	Get maximum length of center value.
bool	is_right () const
	Get right value.
void	set_right (const bool new_right)
	Set right value.
size_t	maxlenof_right () const
	Get maximum length of right value.
uint32_t	intensity () const
	Get intensity value.
void	set_intensity (const uint32_t new_intensity)
	Set intensity value.
size_t	maxlenof_intensity () const
	Get maximum length of intensity value.
virtual Message *	clone () const
	Clone this message.

Detailed Description

KickMessage Fawkes BlackBoard Interface Message.

Definition at line 84 of file KickerInterface.h.

Constructor & Destructor Documentation

fawkes::KickerInterface::KickMessage::KickMessage	(	const bool	ini_left,
		const bool	ini_center,
		const bool	ini_right,
		const uint32_t	ini_intensity
	)

Constructor with initial values.

Parameters:

	ini_left	initial value for left
	ini_center	initial value for center
	ini_right	initial value for right
	ini_intensity	initial value for intensity

Definition at line 310 of file KickerInterface.cpp.

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

fawkes::KickerInterface::KickMessage::KickMessage ( )

Constructor.

Definition at line 327 of file KickerInterface.cpp.

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

Referenced by clone().

fawkes::KickerInterface::KickMessage::~KickMessage ( )

Destructor.

Definition at line 341 of file KickerInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::KickerInterface::KickMessage::KickMessage ( const KickMessage * m )

Copy constructor.

Parameters:

m

message to copy from

Definition at line 349 of file KickerInterface.cpp.

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

Member Function Documentation

Message * fawkes::KickerInterface::KickMessage::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 485 of file KickerInterface.cpp.

References KickMessage().

uint32_t fawkes::KickerInterface::KickMessage::intensity ( ) const

Get intensity value.

Intensity in the range [0..255].

Returns:: intensity value

Definition at line 454 of file KickerInterface.cpp.

bool fawkes::KickerInterface::KickMessage::is_center ( ) const

Get center value.

True to kick with central kicker.

Returns:: center value

Definition at line 394 of file KickerInterface.cpp.

bool fawkes::KickerInterface::KickMessage::is_left ( ) const

Get left value.

True to kick with left kicker.

Returns:: left value

Definition at line 364 of file KickerInterface.cpp.

bool fawkes::KickerInterface::KickMessage::is_right ( ) const

Get right value.

True to kick with right kicker.

Returns:: right value

Definition at line 424 of file KickerInterface.cpp.

size_t fawkes::KickerInterface::KickMessage::maxlenof_center ( ) const

Get maximum length of center value.

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

Definition at line 404 of file KickerInterface.cpp.

size_t fawkes::KickerInterface::KickMessage::maxlenof_intensity ( ) const

Get maximum length of intensity value.

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

Definition at line 464 of file KickerInterface.cpp.

size_t fawkes::KickerInterface::KickMessage::maxlenof_left ( ) const

Get maximum length of left value.

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

Definition at line 374 of file KickerInterface.cpp.

size_t fawkes::KickerInterface::KickMessage::maxlenof_right ( ) const

Get maximum length of right value.

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

Definition at line 434 of file KickerInterface.cpp.

void fawkes::KickerInterface::KickMessage::set_center ( const bool new_center )

Set center value.

True to kick with central kicker.

Parameters:

new_center

new center value

Definition at line 414 of file KickerInterface.cpp.

void fawkes::KickerInterface::KickMessage::set_intensity ( const uint32_t new_intensity )

Set intensity value.

Intensity in the range [0..255].

Parameters:

new_intensity

new intensity value

Definition at line 474 of file KickerInterface.cpp.

void fawkes::KickerInterface::KickMessage::set_left ( const bool new_left )

Set left value.

True to kick with left kicker.

Parameters:

new_left

new left value

Definition at line 384 of file KickerInterface.cpp.

void fawkes::KickerInterface::KickMessage::set_right ( const bool new_right )

Set right value.

True to kick with right kicker.

Parameters:

new_right

new right value

Definition at line 444 of file KickerInterface.cpp.

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

src/interfaces/KickerInterface.h
src/interfaces/KickerInterface.cpp

fawkes::KickerInterface::KickMessage Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation