SetEnabledMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::SetEnabledMessage:

Classes
struct	SetEnabledMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	SetEnabledMessage (const bool ini_enabled)
	Constructor with initial values.
	SetEnabledMessage ()
	Constructor.
	~SetEnabledMessage ()
	Destructor.
	SetEnabledMessage (const SetEnabledMessage *m)
	Copy constructor.
bool	is_enabled () const
	Get enabled value.
void	set_enabled (const bool new_enabled)
	Set enabled value.
size_t	maxlenof_enabled () const
	Get maximum length of enabled 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

SetEnabledMessage Fawkes BlackBoard Interface Message.

Definition at line 386 of file KatanaInterface.h.

Constructor & Destructor Documentation

fawkes::KatanaInterface::SetEnabledMessage::SetEnabledMessage ( const bool ini_enabled )

Constructor with initial values.

Parameters:

ini_enabled initial value for enabled

Definition at line 1921 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetEnabledMessage::SetEnabledMessage ( )

Constructor.

Definition at line 1932 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetEnabledMessage::~SetEnabledMessage ( )

Destructor.

Definition at line 1943 of file KatanaInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1951 of file KatanaInterface.cpp.

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

Member Function Documentation

Message * fawkes::KatanaInterface::SetEnabledMessage::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 1997 of file KatanaInterface.cpp.

bool fawkes::KatanaInterface::SetEnabledMessage::is_enabled ( ) const

Get enabled value.

Are motors enabled?

Returns:: enabled value

Definition at line 1966 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

size_t fawkes::KatanaInterface::SetEnabledMessage::maxlenof_enabled ( ) const

Get maximum length of enabled value.

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

Definition at line 1976 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetEnabledMessage::set_enabled ( const bool new_enabled )

Set enabled value.

Are motors enabled?

Parameters:

new_enabled new enabled value

Definition at line 1986 of file KatanaInterface.cpp.

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