SetMotorsMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::SetMotorsMessage:

Classes
struct	SetMotorsMessage_data_t
	Internal data storage, do NOT modify!

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.
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

SetMotorsMessage Fawkes BlackBoard Interface Message.

Definition at line 350 of file Roomba500Interface.h.

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::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, and fawkes::IFT_ENUM.

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

Constructor.

Definition at line 2800 of file Roomba500Interface.cpp.

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

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_ptr, fawkes::Message::data_size, 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation