Fawkes API  Fawkes Development Version
fawkes::NavigatorInterface::NavigatorInterface_data_t Struct Reference

Internal data storage, do NOT modify! More...

List of all members.

Public Attributes

int64_t timestamp_sec
 Interface Unix timestamp, seconds.
int64_t timestamp_usec
 Interface Unix timestamp, micro-seconds.
uint32_t flags
 Bit-wise combination of FLAG_* constants denoting navigator component features.
float x
 Current X-coordinate in the navigator coordinate system.
float y
 Current Y-coordinate in the navigator coordinate system.
float dest_x
 X-coordinate of the current destination, or 0.0 if no target has been set.
float dest_y
 Y-coordinate of the current destination, or 0.0 if no target has been set.
float dest_ori
 Orientation of the current destination, or 0.0 if no target has been set.
float dest_dist
 Distance to destination in m.
uint32_t msgid
 The ID of the message that is currently being processed, or 0 if no message is being processed.
bool final
 True, if the last goto command has been finished, false if it is still running.
uint32_t error_code
 Failure code set if final is true.
float max_velocity
 Maximum velocity.
float security_distance
 Security distance to keep to obstacles.
bool escaping_enabled
 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.

Detailed Description

Internal data storage, do NOT modify!


Member Data Documentation

Distance to destination in m.

Definition at line 65 of file NavigatorInterface.h.

Orientation of the current destination, or 0.0 if no target has been set.

Definition at line 64 of file NavigatorInterface.h.

X-coordinate of the current destination, or 0.0 if no target has been set.

Definition at line 62 of file NavigatorInterface.h.

Y-coordinate of the current destination, or 0.0 if no target has been set.

Definition at line 63 of file NavigatorInterface.h.

Failure code set if final is true.

0 if no error occured, an error code from ERROR_* constants otherwise (or a bit-wise combination).

Definition at line 70 of file NavigatorInterface.h.

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.

Definition at line 76 of file NavigatorInterface.h.

Referenced by fawkes::NavigatorInterface::SetEscapingMessage::is_escaping_enabled(), and fawkes::NavigatorInterface::SetEscapingMessage::set_escaping_enabled().

True, if the last goto command has been finished, false if it is still running.

Definition at line 68 of file NavigatorInterface.h.

Bit-wise combination of FLAG_* constants denoting navigator component features.

Definition at line 58 of file NavigatorInterface.h.

The ID of the message that is currently being processed, or 0 if no message is being processed.

Definition at line 66 of file NavigatorInterface.h.

Interface Unix timestamp, seconds.

Definition at line 56 of file NavigatorInterface.h.

Interface Unix timestamp, micro-seconds.

Definition at line 57 of file NavigatorInterface.h.


The documentation for this struct was generated from the following file: