RoadNetwork configuration builder keys

Detailed Description

Parameters used during the RoadNetwork building process.

When parameters are omitted the default value will be used.

Example of use:

const std::map<std::string, std::string> builder_configuration {
  {"maliput_osm::builder::kRoadGeometryId", "appian_way_road_geometry"},
  {"maliput_osm::builder::kOsmPath", "appian_way.osm"},
  {"maliput_osm::builder::kOrigin", "{34., 58.}"},
  {"maliput_osm::builder::kLinearTolerance", "1e-3"},
  {"maliput_osm::builder::kAngularTolerance", "1e-3"},
};
auto road_network = maliput_osm::builder::RoadNetworkBuilder(builder_configuration)();

Variables
static constexpr char const *	kRoadGeometryId {maliput_sparse::loader::config::kRoadGeometryId}
	A string that works as ID of the RoadGeometry. More...
static constexpr char const *	kOsmFile {"osm_file"}
	Path to the OSM file to be loaded. More...
static constexpr char const *	kOrigin {"origin"}
	Lat/lon coordinate of the origin of the OSM file. More...
static constexpr char const *	kLinearTolerance {maliput_sparse::loader::config::kLinearTolerance}
	RoadGeometry's linear tolerance. More...
static constexpr char const *	kAngularTolerance {maliput_sparse::loader::config::kAngularTolerance}
	RoadGeometry's angular tolerance. More...
static constexpr char const *	kScaleLength {maliput_sparse::loader::config::kScaleLength}
	RoadGeometry's scale length. More...
static constexpr char const *	kInertialToBackendFrameTranslation
	Translation from maliput to maliput_osm inertial frame. More...
static constexpr char const *	kRoadRuleBook {maliput_sparse::loader::config::kRoadRuleBook}
	Path to the configuration file to load a RoadRulebook. More...
static constexpr char const *	kRuleRegistry {maliput_sparse::loader::config::kRuleRegistry}
	Path to the configuration file to load a RoadRulebook. More...
static constexpr char const *	kTrafficLightBook {maliput_sparse::loader::config::kTrafficLightBook}
	Path to the configuration file to load a TrafficLightBook. More...
static constexpr char const *	kPhaseRingBook {maliput_sparse::loader::config::kPhaseRingBook}
	Path to the configuration file to load a PhaseRingBook. More...
static constexpr char const *	kIntersectionBook {maliput_sparse::loader::config::kIntersectionBook}
	Path to the configuration file to load a IntersectionBook. More...

Variable Documentation

kAngularTolerance

constexpr char const* kAngularTolerance {maliput_sparse::loader::config::kAngularTolerance}

staticconstexpr

RoadGeometry's angular tolerance.

• Default: "1e-3"

kInertialToBackendFrameTranslation

constexpr char const* kInertialToBackendFrameTranslation

staticconstexpr

Initial value:

{
    maliput_sparse::loader::config::kInertialToBackendFrameTranslation}

Translation from maliput to maliput_osm inertial frame.

The format of the 3-dimensional vector that is expected to be passed should be {X, Y, Z}. Same format as maliput::math::Vector3 is serialized.

• Default: "{0., 0., 0.}"

kIntersectionBook

constexpr char const* kIntersectionBook {maliput_sparse::loader::config::kIntersectionBook}

staticconstexpr

Path to the configuration file to load a IntersectionBook.

• Default: ""

kLinearTolerance

constexpr char const* kLinearTolerance {maliput_sparse::loader::config::kLinearTolerance}

staticconstexpr

RoadGeometry's linear tolerance.

• Default: "5e-2"

kOrigin

constexpr char const* kOrigin {"origin"}

staticconstexpr

Lat/lon coordinate of the origin of the OSM file.

The format of the 2-dimensional vector that is expected to be passed should be {X, Y}. Same format as maliput::math::Vector2 is serialized.

• Default: "{0., 0.}"

kOsmFile

constexpr char const* kOsmFile {"osm_file"}

staticconstexpr

Path to the OSM file to be loaded.

• Default: ""

kPhaseRingBook

constexpr char const* kPhaseRingBook {maliput_sparse::loader::config::kPhaseRingBook}

staticconstexpr

Path to the configuration file to load a PhaseRingBook.

• Default: ""

kRoadGeometryId

constexpr char const* kRoadGeometryId {maliput_sparse::loader::config::kRoadGeometryId}

staticconstexpr

A string that works as ID of the RoadGeometry.

• Default: "maliput"

kRoadRuleBook

constexpr char const* kRoadRuleBook {maliput_sparse::loader::config::kRoadRuleBook}

staticconstexpr

Path to the configuration file to load a RoadRulebook.

• Default: ""

kRuleRegistry

constexpr char const* kRuleRegistry {maliput_sparse::loader::config::kRuleRegistry}

staticconstexpr

Path to the configuration file to load a RoadRulebook.

• Default: ""

kScaleLength

constexpr char const* kScaleLength {maliput_sparse::loader::config::kScaleLength}

staticconstexpr

RoadGeometry's scale length.

• Default: "1.0"

kTrafficLightBook

constexpr char const* kTrafficLightBook {maliput_sparse::loader::config::kTrafficLightBook}

staticconstexpr

Path to the configuration file to load a TrafficLightBook.

• Default: ""