#include <cartotype_navigation.h>
Parameters for creating a route.
◆ Read()
void CartoTypeCore::RouteParam::Read |
( |
InputStream & |
aInput | ) |
|
Reads this object from an input stream.
◆ Write()
void CartoTypeCore::RouteParam::Write |
( |
OutputStream & |
aOutput | ) |
const |
Writes this object to an output stream.
◆ Best
bool CartoTypeCore::RouteParam::Best = false |
If true, calculate the best route through the points, rather than a route through the points in order.
◆ EndFixed
bool CartoTypeCore::RouteParam::EndFixed = true |
If true, and if Best is true, the route always ends at the last point in RoutePointArray.
◆ InferHeading
bool CartoTypeCore::RouteParam::InferHeading = true |
If true, infer the heading at intermediate points in a route with more than two points.
◆ Iterations
uint32_t CartoTypeCore::RouteParam::Iterations = 0 |
The number of iterations to be used when calculating a best route. If zero, a default value is used.
◆ KSerializationVersion
constexpr uint32_t CartoTypeCore::RouteParam::KSerializationVersion = 1 |
|
staticconstexpr |
The version of the format in which this class is serialized. Bump this number when changing the class or any of its components.
◆ PointArray
◆ Profile
The route profile is used if the router allows profiles to be set.
◆ ProfileIndex
uint32_t CartoTypeCore::RouteParam::ProfileIndex = 0 |
The profile index is used if there are built-in route profiles.
◆ SnapToNodes
bool CartoTypeCore::RouteParam::SnapToNodes = false |
If true, snap points to nearest nodes (junctions) before calculating the route.
◆ StartFixed
bool CartoTypeCore::RouteParam::StartFixed = true |
If true, and if Best is true, the route always starts at the first point in RoutePointArray.
The documentation for this class was generated from the following file: