Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
fawkes::NavigatorInterface::SetEscapingMessage Class Reference

SetEscapingMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::SetEscapingMessage:

List of all members.

Classes

struct  SetEscapingMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetEscapingMessage (const bool ini_escaping_enabled)
 Constructor with initial values.
 SetEscapingMessage ()
 Constructor.
 ~SetEscapingMessage ()
 Destructor.
 SetEscapingMessage (const SetEscapingMessage *m)
 Copy constructor.
bool is_escaping_enabled () const
 Get escaping_enabled value.
void set_escaping_enabled (const bool new_escaping_enabled)
 Set escaping_enabled value.
size_t maxlenof_escaping_enabled () const
 Get maximum length of escaping_enabled value.
virtual Messageclone () 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.
Messageoperator= (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 Timetime_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.
Interfaceinterface () 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_tdata_ts
 data timestamp aliasing pointer

Detailed Description


Constructor & Destructor Documentation

fawkes::NavigatorInterface::SetEscapingMessage::SetEscapingMessage ( const bool  ini_escaping_enabled)

Constructor with initial values.

Parameters:
ini_escaping_enabledinitial value for escaping_enabled

Definition at line 1471 of file NavigatorInterface.cpp.

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

fawkes::NavigatorInterface::SetEscapingMessage::SetEscapingMessage ( )
fawkes::NavigatorInterface::SetEscapingMessage::~SetEscapingMessage ( )

Destructor.

Definition at line 1493 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NavigatorInterface::SetEscapingMessage::SetEscapingMessage ( const SetEscapingMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1501 of file NavigatorInterface.cpp.

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


Member Function Documentation

Message * fawkes::NavigatorInterface::SetEscapingMessage::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 1553 of file NavigatorInterface.cpp.

bool fawkes::NavigatorInterface::SetEscapingMessage::is_escaping_enabled ( ) const

Get escaping_enabled value.

This is used for navigation components with integrated collision avoidance, to check whether the navigator should stop when an obstacle obstructs the path, or if it should escape.

Returns:
escaping_enabled value

Definition at line 1519 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::SetEscapingMessage::maxlenof_escaping_enabled ( ) const

Get maximum length of escaping_enabled value.

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

Definition at line 1529 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::SetEscapingMessage::set_escaping_enabled ( const bool  new_escaping_enabled)

Set escaping_enabled value.

This is used for navigation components with integrated collision avoidance, to check whether the navigator should stop when an obstacle obstructs the path, or if it should escape.

Parameters:
new_escaping_enablednew escaping_enabled value

Definition at line 1542 of file NavigatorInterface.cpp.


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