Module api

Module api 

Source

Modules§

rules

Structs§

BranchPoint
A BranchPoint is a node in the network of a RoadGeometry at which Lanes connect to one another. A BranchPoint is a collection of LaneEnds specifying the Lanes (and, in particular, which ends of the Lanes) are connected at the BranchPoint.
HBounds
Bounds in the elevation dimension (h component) of a Lane-frame, consisting of a pair of minimum and maximum h value. The bounds must straddle h = 0, i.e., the minimum must be <= 0 and the maximum must be >= 0.
InertialPosition
A position in 3-dimensional geographical Cartesian space, i.e., in the Inertial-frame, consisting of three components x, y, and z.
Intersection
An abstract convenience class that aggregates information pertaining to an intersection. Its primary purpose is to serve as a single source of this information and to remove the need for users to query numerous disparate data structures and state providers.
IntersectionBook
A book of Intersections.
IsoLaneVelocity
Isometric velocity vector in a Lane-frame.
Junction
A Junction is a closed set of Segments which have physically coplanar road surfaces, in the sense that RoadPositions with the same h value (height above surface) in the domains of two Segments map to the same InertialPosition. The Segments need not be directly connected to one another in the network topology.
Lane
A Lane represents a lane of travel in a road network. A Lane defines a curvilinear coordinate system covering the road surface, with a longitudinal ‘s’ coordinate that expresses the arc-length along a central reference curve. The reference curve nominally represents an ideal travel trajectory along the Lane.
LaneEndSet
A set of LaneEnds.
LanePosition
A 3-dimensional position in a Lane-frame, consisting of three components:
LanePositionResult
Represents the result of a LanePosition query. This struct contains the LanePosition, the nearest InertialPosition to that LanePosition, and the distance between the input InertialPosition and the nearest InertialPosition.
LaneSRange
Directed longitudinal range of a specific Lane, identified by a LaneId. Similar to SRange, but associated with a specific Lane.
LaneSRoute
A route, possibly spanning multiple (end-to-end) lanes.
RBounds
Bounds in the lateral dimension (r component) of a Lane-frame, consisting of a pair of minimum and maximum r value. The bounds must straddle r = 0, i.e., the minimum must be <= 0 and the maximum must be >= 0.
RoadGeometry
Represents the geometry of a road network.
RoadNetwork
Represents a complete Maliput road network.
RoadPosition
A position in the road network compound by a specific lane and a lane-frame position in that lane. This position is defined by a Lane and a LanePosition.
RoadPositionResult
Represents the result of a RoadPosition query. This struct contains the RoadPosition, the nearest InertialPosition to that RoadPosition, and the distance between the input InertialPosition and the nearest InertialPosition.
Rotation
A 3-dimensional rotation in the road network. This struct represents a rotation in the road network, which can be defined using a quaternion or roll-pitch-yaw angles. It provides methods to create a rotation, convert between representations, and apply the rotation to an inertial position.
SRange
Directed, inclusive longitudinal (s value) range from s0 to s1.
Segment
A Segment represents a bundle of adjacent Lanes which share a continuously traversable road surface. Every LanePosition on a given Lane of a Segment has a corresponding LanePosition on each other Lane, all with the same height-above-surface h, that all map to the same GeoPoint in 3-space.

Enums§

LaneEnd
A specific endpoint of a specific Lane.