maliput
|
Namespaces | |
rules | |
test | |
Classes | |
class | BasicIdIndex |
Basic general-purpose concrete implementation of the RoadGeometry::IdIndex interface. More... | |
class | BranchPoint |
A BranchPoint is a node in the network of a RoadGeometry at which Lanes connect to one another. More... | |
class | HBounds |
Bounds in the elevation dimension (h component) of a Lane -frame, consisting of a pair of minimum and maximum h value. More... | |
class | InertialPosition |
A position in 3-dimensional geographical Cartesian space, i.e., in the Inertial -frame, consisting of three components x, y, and z. More... | |
class | Intersection |
An abstract convenience class that aggregates information pertaining to an intersection. More... | |
class | IntersectionBook |
An abstract interface for providing the mapping from Intersection::Id to Intersection. More... | |
struct | IsoLaneVelocity |
Isometric velocity vector in a Lane -frame. More... | |
class | 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. More... | |
class | Lane |
A Lane represents a lane of travel in a road network. More... | |
struct | LaneEnd |
A specific endpoint of a specific Lane. More... | |
class | LaneEndSet |
A set of LaneEnds. More... | |
class | LanePosition |
A 3-dimensional position in a Lane -frame, consisting of three components: More... | |
struct | LanePositionResult |
Included in the return result of Lane::ToLanePosition(). More... | |
class | LaneSRange |
Directed longitudinal range of a specific Lane, identified by a LaneId. More... | |
class | LaneSRoute |
A route, possibly spanning multiple (end-to-end) lanes. More... | |
class | RBounds |
Bounds in the lateral dimension (r component) of a Lane -frame, consisting of a pair of minimum and maximum r value. More... | |
class | RoadGeometry |
Abstract API for the geometry of a road network, including both the network topology and the geometry of its embedding in 3-space. More... | |
class | RoadNetwork |
A container that aggregates everything pertaining to Maliput. More... | |
struct | RoadNetworkValidatorOptions |
Provides configuration options for the RoadNetworkValidator. More... | |
struct | RoadPosition |
A position in the road network, consisting of a pointer to a specific Lane and a Lane -frame position in that Lane. More... | |
struct | RoadPositionResult |
Included in the return result of RoadGeometry::FindRoadPositions() and RoadGeometry::ToRoadPosition(). More... | |
class | Rotation |
A 3-dimensional rotation. More... | |
class | Segment |
A Segment represents a bundle of adjacent Lanes which share a continuously traversable road surface. More... | |
class | SRange |
Directed, inclusive longitudinal (s value) range from s0 to s1. More... | |
class | TypeSpecificIdentifier |
TypeSpecificIdentifier<T> represents an identifier specifically identifying an entity of type T . More... | |
class | UniqueId |
Represents an unique identifier. More... | |
Typedefs | |
using | BranchPointId = TypeSpecificIdentifier< class BranchPoint > |
using | JunctionId = TypeSpecificIdentifier< class Junction > |
Persistent identifier for a Junction element. More... | |
using | LaneId = TypeSpecificIdentifier< class Lane > |
Persistent identifier for a Lane element. More... | |
using | RoadGeometryId = TypeSpecificIdentifier< class RoadGeometry > |
Persistent identifier for a RoadGeometry element. More... | |
using | SegmentId = TypeSpecificIdentifier< class Segment > |
Persistent identifier for a Segment element. More... | |
Functions | |
common::ComparisonResult< LanePositionResult > | IsLanePositionResultClose (const LanePositionResult &lpr_a, const LanePositionResult &lpr_b, double tolerance) |
Compares equality within tolerance deviation of the maliput::api::LanePositionResult lpr_a and lpr_B . More... | |
common::ComparisonResult< RoadPositionResult > | IsRoadPositionResultClose (const maliput::api::RoadPositionResult &rpr_a, const maliput::api::RoadPositionResult &rpr_b, double tolerance) |
Compares equality within tolerance deviation of the maliput::api::RoadPositionResult rpr_a and rpr_B . More... | |
common::ComparisonResult< InertialPosition > | IsInertialPositionClose (const InertialPosition &pos1, const InertialPosition &pos2, double tolerance) |
Compares equality within tolerance deviation of two InertialPosition objects. More... | |
common::ComparisonResult< LanePosition > | IsLanePositionClose (const LanePosition &pos1, const LanePosition &pos2, double tolerance) |
Compares equality within tolerance deviation of two LanePosition objects. More... | |
common::ComparisonResult< Rotation > | IsRotationClose (const Rotation &rot1, const Rotation &rot2, double tolerance) |
Compares equality within tolerance deviation of two Rotation objects. More... | |
common::ComparisonResult< RBounds > | IsRBoundsClose (const RBounds &rbounds1, const RBounds &rbounds2, double tolerance) |
Compares equality within tolerance deviation of two RBounds objects. More... | |
common::ComparisonResult< HBounds > | IsHBoundsClose (const HBounds &hbounds1, const HBounds &hbounds2, double tolerance) |
Compares equality within tolerance deviation of two HBounds objects. More... | |
common::ComparisonResult< LaneEnd > | IsLaneEndEqual (const LaneEnd &lane_end1, const LaneEnd &lane_end2) |
Compares equality of two LaneEnd objects. More... | |
common::ComparisonResult< Junction > | IsEqual (const char *a_expression, const char *b_expression, const Junction *a, const Junction *b) |
Compares equality of two Junction objects. More... | |
common::ComparisonResult< Segment > | IsEqual (const char *a_expression, const char *b_expression, const Segment *a, const Segment *b) |
Compares equality of two Segment objects. More... | |
common::ComparisonResult< Lane > | IsEqual (const char *a_expression, const char *b_expression, const Lane *a, const Lane *b) |
Compares equality of two Lane objects. More... | |
common::ComparisonResult< BranchPoint > | IsEqual (const char *a_expression, const char *b_expression, const BranchPoint *a, const BranchPoint *b) |
Compares equality of two BranchPoint objects. More... | |
common::ComparisonResult< bool > | IsEqual (const char *a_expression, const char *b_expression, bool a, bool b) |
Compares equality of two booleans. More... | |
common::ComparisonResult< double > | IsEqual (const char *a_expression, const char *b_expression, double a, double b) |
Compares equality of two doubles. More... | |
common::ComparisonResult< std::size_t > | IsEqual (const char *a_expression, const char *b_expression, std::size_t a, std::size_t b) |
Compares equality of two std::size_t. More... | |
template<typename T > | |
common::ComparisonResult< TypeSpecificIdentifier< T > > | IsEqual (const char *a_expression, const char *b_expression, const TypeSpecificIdentifier< T > &a, const TypeSpecificIdentifier< T > &b) |
Compares equality of two TypeSpecificIdentifier<T>. More... | |
common::ComparisonResult< SRange > | IsEqual (const SRange &s_range_1, const SRange &s_range_2) |
Compares equality of two SRanges. More... | |
common::ComparisonResult< LaneSRange > | IsEqual (const LaneSRange &lane_s_range_1, const LaneSRange &lane_s_range_2) |
Compares equality of two LaneSRange. More... | |
common::ComparisonResult< std::vector< LaneSRange > > | IsEqual (const std::vector< LaneSRange > &lane_s_ranges_1, const std::vector< LaneSRange > &lane_s_ranges_2) |
Compares equality of two std::vector<LaneSRange>. More... | |
common::ComparisonResult< LaneSRoute > | IsEqual (const LaneSRoute &lane_s_route_1, const LaneSRoute &lane_s_route_2) |
Compares equality of two LaneSRoute. More... | |
common::ComparisonResult< InertialPosition > | IsEqual (const InertialPosition &inertial_position_1, const InertialPosition &inertial_position_2) |
Compares equality of two InertialPosition. More... | |
common::ComparisonResult< Rotation > | IsEqual (const Rotation &rotation_1, const Rotation &rotation_2) |
Compares equality of two Rotation. More... | |
common::ComparisonResult< LaneEnd::Which > | IsEqual (const LaneEnd::Which &which_1, const LaneEnd::Which &which_2) |
Compares equality of two LaneEnd::Which. More... | |
common::ComparisonResult< LaneEnd > | IsEqual (const LaneEnd &lane_end_1, const LaneEnd &lane_end_2) |
Compares equality of two LaneEnd. More... | |
std::optional< std::string > | CheckIdIndexing (const RoadGeometry *road_geometry) |
Checks that the given RoadGeometry's ById() indexing is correct. More... | |
std::ostream & | operator<< (std::ostream &out, const LaneEnd::Which &which_end) |
Streams a string representation of which_end into out . More... | |
std::ostream & | operator<< (std::ostream &out, const InertialPosition &inertial_position) |
Streams a string representation of inertial_position into out . More... | |
std::ostream & | operator<< (std::ostream &out, const Rotation &rotation) |
Streams a string representation of rotation into out . More... | |
std::ostream & | operator<< (std::ostream &out, const LanePosition &lane_position) |
Streams a string representation of lane_position into out . More... | |
bool | IsContiguous (const LaneSRange &lane_range_a, const LaneSRange &lane_range_b, const RoadGeometry *road_geometry) |
Evaluates whether lane_range_a end point is G1 contiguous with lane_range_b start pose. More... | |
bool | IsIncluded (const InertialPosition &inertial_position, const std::vector< LaneSRange > &lane_s_ranges, const RoadGeometry *road_geometry) |
Evaluates whether inertial_position is within lane_s_ranges . More... | |
void | ValidateRoadNetwork (const RoadNetwork &road_network, const RoadNetworkValidatorOptions &options) |
Validates a RoadNetwork. More... | |
using BranchPointId = TypeSpecificIdentifier<class BranchPoint> |
using JunctionId = TypeSpecificIdentifier<class Junction> |
Persistent identifier for a Junction element.
using LaneId = TypeSpecificIdentifier<class Lane> |
Persistent identifier for a Lane element.
using RoadGeometryId = TypeSpecificIdentifier<class RoadGeometry> |
Persistent identifier for a RoadGeometry element.
using SegmentId = TypeSpecificIdentifier<class Segment> |
Persistent identifier for a Segment element.
std::optional< std::string > CheckIdIndexing | ( | const RoadGeometry * | road_geometry | ) |
Checks that the given RoadGeometry's ById() indexing is correct.
road_geometry | The RoadGeometry to check. |
bool IsContiguous | ( | const LaneSRange & | lane_range_a, |
const LaneSRange & | lane_range_b, | ||
const RoadGeometry * | road_geometry | ||
) |
Evaluates whether lane_range_a
end point is G1 contiguous with lane_range_b
start pose.
lane_range_a | A LaneSRange in road_geometry . Its ID must belong to a road_geometry 's Lane. |
lane_range_b | A LaneSRange in road_geometry . Its ID must belong to a road_geometry 's Lane. |
road_geometry | The RoadGeometry where lane_range_a and lane_range_b are contained. It must not be nullptr. |
lane_range_a
end pose and lane_range_b
start pose are within linear and angular tolerance in the Inertial
-frame. Otherwise, it returns false.common::assertion_error | When lane_range_a 's Lane is not found in road_geometry . |
common::assertion_error | When lane_range_b 's Lane is not found in road_geometry . |
common::assertion_error | When road_geometry is nullptr. |
common::ComparisonResult< bool > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
bool | a, | ||
bool | b | ||
) |
Compares equality of two booleans.
a_expression | Literal expression of the first boolean. |
b_expression | Literal expression of the second boolean. |
a | The first boolean to compare. |
b | The second boolean to compare. |
common::ComparisonResult< BranchPoint > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
const BranchPoint * | a, | ||
const BranchPoint * | b | ||
) |
Compares equality of two BranchPoint objects.
a_expression | Literal expression of the first BranchPoint. |
b_expression | Literal expression of the second BranchPoint. |
a | The first BranchPoint to compare. |
b | The second BranchPoint to compare. |
common::ComparisonResult< maliput::api::Junction > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
const Junction * | a, | ||
const Junction * | b | ||
) |
Compares equality of two Junction objects.
a_expression | Literal expression of the first Junction. |
b_expression | Literal expression of the second Junction. |
a | The first Junction to compare. |
b | The second Junction to compare. |
common::ComparisonResult< Lane > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
const Lane * | a, | ||
const Lane * | b | ||
) |
common::ComparisonResult< Segment > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
const Segment * | a, | ||
const Segment * | b | ||
) |
common::ComparisonResult<TypeSpecificIdentifier<T> > maliput::api::IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
const TypeSpecificIdentifier< T > & | a, | ||
const TypeSpecificIdentifier< T > & | b | ||
) |
Compares equality of two TypeSpecificIdentifier<T>.
@paramT T The type of the TypeSpecificIdentifier.
a_expression | Literal expression of the first TypeSpecificIdentifier. |
b_expression | Literal expression of the second TypeSpecificIdentifier. |
a | The first TypeSpecificIdentifier to compare. |
b | The second TypeSpecificIdentifier to compare. |
common::ComparisonResult< double > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
double | a, | ||
double | b | ||
) |
Compares equality of two doubles.
a_expression | Literal expression of the first double. |
b_expression | Literal expression of the second double. |
a | The first double to compare. |
b | The second double to compare. |
common::ComparisonResult< std::size_t > IsEqual | ( | const char * | a_expression, |
const char * | b_expression, | ||
std::size_t | a, | ||
std::size_t | b | ||
) |
Compares equality of two std::size_t.
a_expression | Literal expression of the first std::size_t. |
b_expression | Literal expression of the second std::size_t. |
a | The first std::size_t to compare. |
b | The second std::size_t to compare. |
common::ComparisonResult< InertialPosition > IsEqual | ( | const InertialPosition & | inertial_position_1, |
const InertialPosition & | inertial_position_2 | ||
) |
Compares equality of two InertialPosition.
inertial_position_1 | The first InertialPosition to compare. |
inertial_position_2 | The second InertialPosition to compare. |
common::ComparisonResult< LaneEnd > IsEqual | ( | const LaneEnd & | lane_end_1, |
const LaneEnd & | lane_end_2 | ||
) |
common::ComparisonResult< LaneEnd::Which > IsEqual | ( | const LaneEnd::Which & | which_1, |
const LaneEnd::Which & | which_2 | ||
) |
Compares equality of two LaneEnd::Which.
which_1 | The first LaneEnd::Which to compare. |
which_2 | The second LaneEnd::Which to compare. |
common::ComparisonResult< LaneSRange > IsEqual | ( | const LaneSRange & | lane_s_range_1, |
const LaneSRange & | lane_s_range_2 | ||
) |
Compares equality of two LaneSRange.
lane_s_range_1 | The first LaneSRange to compare. |
lane_s_range_2 | The second LaneSRange to compare. |
common::ComparisonResult< LaneSRoute > IsEqual | ( | const LaneSRoute & | lane_s_route_1, |
const LaneSRoute & | lane_s_route_2 | ||
) |
Compares equality of two LaneSRoute.
lane_s_route_1 | The first LaneSRoute to compare. |
lane_s_route_2 | The second LaneSRoute to compare. |
common::ComparisonResult< Rotation > IsEqual | ( | const Rotation & | rotation_1, |
const Rotation & | rotation_2 | ||
) |
common::ComparisonResult< SRange > IsEqual | ( | const SRange & | s_range_1, |
const SRange & | s_range_2 | ||
) |
common::ComparisonResult< std::vector< LaneSRange > > IsEqual | ( | const std::vector< LaneSRange > & | lane_s_ranges_1, |
const std::vector< LaneSRange > & | lane_s_ranges_2 | ||
) |
Compares equality of two std::vector<LaneSRange>.
lane_s_ranges_1 | The first std::vector<LaneSRange> to compare. |
lane_s_ranges_2 | The second std::vector<LaneSRange> to compare. |
common::ComparisonResult< HBounds > IsHBoundsClose | ( | const HBounds & | hbounds1, |
const HBounds & | hbounds2, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of two HBounds objects.
hbounds1 | A HBounds object to compare. |
hbounds1 | A HBounds object to compare. |
tolerance | An allowable absolute deviation for each HBounds's instance value. |
bool IsIncluded | ( | const InertialPosition & | inertial_position, |
const std::vector< LaneSRange > & | lane_s_ranges, | ||
const RoadGeometry * | road_geometry | ||
) |
Evaluates whether inertial_position
is within lane_s_ranges
.
inertial_position | A InertialPosition in the Inertial -frame. |
lane_s_ranges | A vector of LaneSRanges that define a region. |
road_geometry | The RoadGeometry where lane_s_ranges is contained. It must not be nullptr. |
inertial_position
is within lane_s_ranges
. inertial_position
is contained if the distance to the closest LanePosition of lane_s_ranges
is less or equal than the linear tolerance of the road_geometry
.common::assertion_error | When road_geometry is nullptr. |
common::assertion_error | When Lanes in lane_s_ranges are not found in road_geometry . |
common::ComparisonResult< InertialPosition > IsInertialPositionClose | ( | const InertialPosition & | pos1, |
const InertialPosition & | pos2, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of two InertialPosition objects.
pos1 | A InertialPosition object to compare. |
pos2 | A InertialPosition object to compare. |
tolerance | An allowable absolute deviation for each InertialPosition's coordinate. |
common::ComparisonResult< LaneEnd > IsLaneEndEqual | ( | const LaneEnd & | lane_end1, |
const LaneEnd & | lane_end2 | ||
) |
common::ComparisonResult< LanePosition > IsLanePositionClose | ( | const LanePosition & | pos1, |
const LanePosition & | pos2, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of two LanePosition objects.
pos1 | A LanePosition object to compare. |
pos2 | A LanePosition object to compare. |
tolerance | An allowable absolute deviation for each LanePosition's coordinate. |
common::ComparisonResult< LanePositionResult > IsLanePositionResultClose | ( | const LanePositionResult & | lpr_a, |
const LanePositionResult & | lpr_b, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of the maliput::api::LanePositionResult lpr_a
and lpr_B
.
lpr_a | The first LanePositionResult to compare. |
lpr_b | The second LanePositionResult to compare. |
tolerance | The tolerance to use for the comparison. |
common::ComparisonResult< RBounds > IsRBoundsClose | ( | const RBounds & | rbounds1, |
const RBounds & | rbounds2, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of two RBounds objects.
rbounds1 | A RBounds object to compare. |
rbounds2 | A RBounds object to compare. |
tolerance | An allowable absolute deviation for each RBounds's instance value. |
common::ComparisonResult< RoadPositionResult > IsRoadPositionResultClose | ( | const maliput::api::RoadPositionResult & | rpr_a, |
const maliput::api::RoadPositionResult & | rpr_b, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of the maliput::api::RoadPositionResult rpr_a
and rpr_B
.
rpr_a | The first RoadPositionResult to compare. |
rpr_b | The second RoadPositionResult to compare. |
tolerance | The tolerance to use for the comparison. |
common::ComparisonResult< Rotation > IsRotationClose | ( | const Rotation & | rot1, |
const Rotation & | rot2, | ||
double | tolerance | ||
) |
Compares equality within tolerance
deviation of two Rotation objects.
Comparison will evaluate the inner Rotation's Euler angles.
rot1 | A Rotation object to compare. |
rot2 | A Rotation object to compare. |
tolerance | An allowable absolute deviation for each Rotation's coordinate. |
std::ostream & operator<< | ( | std::ostream & | out, |
const InertialPosition & | inertial_position | ||
) |
Streams a string representation of inertial_position
into out
.
Returns out
. This method is provided for the purposes of debugging or text-logging. It is not intended for serialization.
std::ostream & operator<< | ( | std::ostream & | out, |
const LaneEnd::Which & | which_end | ||
) |
Streams a string representation of which_end
into out
.
Returns out
. This method is provided for the purposes of debugging or text-logging. It is not intended for serialization.
std::ostream & operator<< | ( | std::ostream & | out, |
const LanePosition & | lane_position | ||
) |
Streams a string representation of lane_position
into out
.
Returns out
. This method is provided for the purposes of debugging or text-logging. It is not intended for serialization.
std::ostream & operator<< | ( | std::ostream & | out, |
const Rotation & | rotation | ||
) |
Streams a string representation of rotation
into out
.
Returns out
. This method is provided for the purposes of debugging or text-logging. It is not intended for serialization.
void ValidateRoadNetwork | ( | const RoadNetwork & | road_network, |
const RoadNetworkValidatorOptions & | options | ||
) |
Validates a RoadNetwork.
road_network | The RoadNetwork to validate. |
options | Options for selecting what aspects of RoadNetwork to check. |
maliput::common::assertion_error | When road_network is not valid. |