selfdriving
Public Member Functions | Public Attributes | List of all members
mpp::WaypointStatus Struct Reference

#include <mpp/data/Waypoints.h>

Inheritance diagram for mpp::WaypointStatus:
mpp::Waypoint

Public Member Functions

 WaypointStatus ()=default
 
std::string getAsText () const
 
- Public Member Functions inherited from mpp::Waypoint
 Waypoint ()=default
 
 Waypoint (double target_x, double target_y, double allowed_distance, bool allow_skip=true, std::optional< double > target_heading_=std::nullopt, double speed_ratio_=1.0)
 
mrpt::math::TPose2D targetAsPose () const
 
bool isValid () const
 
std::string getAsText () const
 
mrpt::containers::yaml asYAML () const
 

Public Attributes

bool reached {false}
 
bool skipped {false}
 
mrpt::system::TTimeStamp timestamp_reach = INVALID_TIMESTAMP
 
int counter_seen_reachable {0}
 
- Public Attributes inherited from mpp::Waypoint
mrpt::math::TPoint2D target {INVALID_NUM, INVALID_NUM}
 
std::optional< double > targetHeading
 
std::string targetFrameId = "map"
 
double allowedDistance = INVALID_NUM
 
double speedRatio = 1.0
 
bool allowSkip = true
 
bool preferNotToSkip = false
 

Additional Inherited Members

- Static Public Member Functions inherited from mpp::Waypoint
static Waypoint FromYAML (const mrpt::containers::yaml &d)
 
- Static Public Attributes inherited from mpp::Waypoint
static constexpr int INVALID_NUM {-100000}
 

Detailed Description

A waypoint with an execution status.

Constructor & Destructor Documentation

◆ WaypointStatus()

mpp::WaypointStatus::WaypointStatus ( )
default

Member Function Documentation

◆ getAsText()

std::string mpp::WaypointStatus::getAsText ( ) const

Gets navigation params as a human-readable format

Member Data Documentation

◆ counter_seen_reachable

int mpp::WaypointStatus::counter_seen_reachable {0}

(Initialized to 0 automatically) How many times this waypoint has been seen as "reachable" before it being the current active waypoint.

◆ reached

bool mpp::WaypointStatus::reached {false}

Whether this waypoint has been reached already (to within the allowed distance as per user specifications) or skipped.

◆ skipped

bool mpp::WaypointStatus::skipped {false}

If reached==true this boolean tells whether the waypoint was physically reached (false) or marked as reached because it was skipped (true).

◆ timestamp_reach

mrpt::system::TTimeStamp mpp::WaypointStatus::timestamp_reach = INVALID_TIMESTAMP

Timestamp of when this waypoint was reached. (Default=INVALID_TIMESTAMP means not reached so far)


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