fawkes::NavigatorInterface::SetSecurityDistanceMessage Class Reference
SetSecurityDistanceMessage Fawkes BlackBoard Interface Message. More...
#include <interfaces/NavigatorInterface.h>
Classes | |
| struct | SetSecurityDistanceMessage_data_t |
| Internal data storage, do NOT modify! | |
Public Member Functions | |
| SetSecurityDistanceMessage (const float ini_security_distance) | |
| Constructor with initial values. | |
| SetSecurityDistanceMessage () | |
| Constructor. | |
| ~SetSecurityDistanceMessage () | |
| Destructor. | |
| SetSecurityDistanceMessage (const SetSecurityDistanceMessage *m) | |
| Copy constructor. | |
| float | security_distance () const |
| Get security_distance value. | |
| void | set_security_distance (const float new_security_distance) |
| Set security_distance value. | |
| size_t | maxlenof_security_distance () const |
| Get maximum length of security_distance value. | |
| virtual Message * | clone () const |
| Clone this message. | |
Detailed Description
SetSecurityDistanceMessage Fawkes BlackBoard Interface Message.
Definition at line 352 of file NavigatorInterface.h.
Constructor & Destructor Documentation
| fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage | ( | const float | ini_security_distance | ) |
Constructor with initial values.
- Parameters:
-
ini_security_distance initial value for security_distance
Definition at line 1567 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
| fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage | ( | ) |
Constructor.
Definition at line 1578 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
Referenced by clone().
| fawkes::NavigatorInterface::SetSecurityDistanceMessage::~SetSecurityDistanceMessage | ( | ) |
Destructor.
Definition at line 1589 of file NavigatorInterface.cpp.
References fawkes::Message::data_ptr.
| fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage | ( | const SetSecurityDistanceMessage * | m | ) |
Copy constructor.
- Parameters:
-
m message to copy from
Definition at line 1597 of file NavigatorInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
Member Function Documentation
| Message * fawkes::NavigatorInterface::SetSecurityDistanceMessage::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 1645 of file NavigatorInterface.cpp.
References SetSecurityDistanceMessage().
| size_t fawkes::NavigatorInterface::SetSecurityDistanceMessage::maxlenof_security_distance | ( | ) | const |
Get maximum length of security_distance value.
- Returns:
- length of security_distance value, can be length of the array or number of maximum number of characters for a string
Definition at line 1623 of file NavigatorInterface.cpp.
| float fawkes::NavigatorInterface::SetSecurityDistanceMessage::security_distance | ( | ) | const |
Get security_distance value.
Security distance to keep to obstacles
- Returns:
- security_distance value
Definition at line 1613 of file NavigatorInterface.cpp.
| void fawkes::NavigatorInterface::SetSecurityDistanceMessage::set_security_distance | ( | const float | new_security_distance | ) |
Set security_distance value.
Security distance to keep to obstacles
- Parameters:
-
new_security_distance new security_distance value
Definition at line 1634 of file NavigatorInterface.cpp.
The documentation for this class was generated from the following files:
- src/interfaces/NavigatorInterface.h
- src/interfaces/NavigatorInterface.cpp
