fawkes::NavigatorInterface::SetEscapingMessage Class Reference

SetEscapingMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/NavigatorInterface.h>

Inheritance diagram for fawkes::NavigatorInterface::SetEscapingMessage:

Inheritance graph
[legend]

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 Message * clone () const
 Clone this message.

Detailed Description

SetEscapingMessage Fawkes BlackBoard Interface Message.

Definition at line 272 of file NavigatorInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_escaping_enabled initial value for escaping_enabled

Definition at line 1419 of file NavigatorInterface.cpp.

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

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

Constructor.

Definition at line 1429 of file NavigatorInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 1439 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 1447 of file NavigatorInterface.cpp.

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

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 1498 of file NavigatorInterface.cpp.

References SetEscapingMessage().

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 1464 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 1474 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_enabled new escaping_enabled value

Definition at line 1487 of file NavigatorInterface.cpp.

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