SetMotorsMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::SetMotorsMessage:

Classes
struct	SetMotorsMessage_data_t
	Internal data storage, do NOT modify! More...
Public Member Functions
	SetMotorsMessage (const bool ini_vacuuming, const BrushState ini_main, const BrushState ini_side)
	Constructor with initial values.
	SetMotorsMessage ()
	Constructor.
	~SetMotorsMessage ()
	Destructor.
	SetMotorsMessage (const SetMotorsMessage *m)
	Copy constructor.
bool	is_vacuuming () const
	Get vacuuming value.
void	set_vacuuming (const bool new_vacuuming)
	Set vacuuming value.
size_t	maxlenof_vacuuming () const
	Get maximum length of vacuuming value.
BrushState	main () const
	Get main value.
void	set_main (const BrushState new_main)
	Set main value.
size_t	maxlenof_main () const
	Get maximum length of main value.
BrushState	side () const
	Get side value.
void	set_side (const BrushState new_side)
	Set side value.
size_t	maxlenof_side () const
	Get maximum length of side value.
virtual Message *	clone () const
	Clone this message.

Detailed Description

SetMotorsMessage Fawkes BlackBoard Interface Message.

Constructor & Destructor Documentation

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage	(	const bool	ini_vacuuming,
		const BrushState	ini_main,
		const BrushState	ini_side
	)

Constructor with initial values.

Parameters:

ini_vacuuming	initial value for vacuuming
ini_main	initial value for main
ini_side	initial value for side

Definition at line 2785 of file Roomba500Interface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::vacuuming, fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::main, fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::side, fawkes::Message::add_fieldinfo(), fawkes::IFT_BOOL, and fawkes::IFT_ENUM.

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage ( )

Constructor.

Definition at line 2800 of file Roomba500Interface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::Message::add_fieldinfo(), fawkes::IFT_BOOL, fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::vacuuming, fawkes::IFT_ENUM, fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::main, and fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage_data_t::side.

fawkes::Roomba500Interface::SetMotorsMessage::~SetMotorsMessage ( )

Destructor.

Definition at line 2813 of file Roomba500Interface.cpp.

References fawkes::Interface::data_ptr.

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage ( const SetMotorsMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 2821 of file Roomba500Interface.cpp.

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

Member Function Documentation

Message * fawkes::Roomba500Interface::SetMotorsMessage::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 2927 of file Roomba500Interface.cpp.

bool fawkes::Roomba500Interface::SetMotorsMessage::is_vacuuming ( ) const

Get vacuuming value.

Enable vacuuming?

Returns:: vacuuming value

Definition at line 2836 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().

Roomba500Interface::BrushState fawkes::Roomba500Interface::SetMotorsMessage::main ( ) const

Get main value.

Main brush state.

Returns:: main value

Definition at line 2866 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_main ( ) const

Get maximum length of main value.

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

Definition at line 2876 of file Roomba500Interface.cpp.

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_side ( ) const

Get maximum length of side value.

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

Definition at line 2906 of file Roomba500Interface.cpp.

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_vacuuming ( ) const

Get maximum length of vacuuming value.

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

Definition at line 2846 of file Roomba500Interface.cpp.

void fawkes::Roomba500Interface::SetMotorsMessage::set_main ( const BrushState new_main )

Set main value.

Main brush state.

Parameters:

new_main new main value

Definition at line 2886 of file Roomba500Interface.cpp.

void fawkes::Roomba500Interface::SetMotorsMessage::set_side ( const BrushState new_side )

Set side value.

Side brush state.

Parameters:

new_side new side value

Definition at line 2916 of file Roomba500Interface.cpp.

void fawkes::Roomba500Interface::SetMotorsMessage::set_vacuuming ( const bool new_vacuuming )

Set vacuuming value.

Enable vacuuming?

Parameters:

new_vacuuming new vacuuming value

Definition at line 2856 of file Roomba500Interface.cpp.

Roomba500Interface::BrushState fawkes::Roomba500Interface::SetMotorsMessage::side ( ) const

Get side value.

Side brush state.

Returns:: side value

Definition at line 2896 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().

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

src/libs/interfaces/Roomba500Interface.h
src/plugins/roomba/Roomba500Interface.cpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation