maliput::integration Namespace Reference

Classes
class	ChronoTimer
	Timer implementation based on STL chrono library. More...
struct	DragwayBuildProperties
	Contains the attributes needed for building a dragway::RoadGeometry. More...
class	DynamicEnvironmentHandler
	Abstract API for managing the rules dynamic states of a maliput::api::RoadNetwork. More...
class	FixedPhaseIterationHandler
	DynamicEnvironmentHandler class implementation. More...
struct	MalidriveBuildProperties
	Contains the attributes needed for building a malidrive::RoadNetwork. More...
struct	MaliputOsmBuildProperties
	Contains the attributes needed for building a maliput_osm RoadNetwork. More...
struct	MultilaneBuildProperties
	Contains the attributes needed for building a multilane::RoadGeometry. More...
class	Timer
	Simple Timer API. More...

Enumerations
enum	DynamicEnvironmentHandlerType { kFixedPhaseIterationHandler }
	Types of DynamicEnvironmentHandler implementations. More...
enum	TimerType { kChronoTimer }
	Timer implementations. More...
enum	MaliputImplementation { kMalidrive, kDragway, kMultilane, kOsm }
	Available maliput implementations. More...

Functions
template<typename... Args>
std::unique_ptr< DynamicEnvironmentHandler >	CreateDynamicEnvironmentHandler (const DynamicEnvironmentHandlerType &type, Args &&... args)
	Create Timer. More...
std::unique_ptr< Timer >	CreateTimer (const TimerType &type)
	Create Timer. More...
std::string	MaliputImplementationToString (MaliputImplementation maliput_impl)
	Returns the std::string version of maliput_impl. More...
MaliputImplementation	StringToMaliputImplementation (const std::string &maliput_impl)
	Returns the MaliputImplementation version of maliput_impl. More...
std::unique_ptr< api::RoadNetwork >	CreateDragwayRoadNetwork (const DragwayBuildProperties &build_properties)
	Builds an api::RoadNetwork based on Dragway implementation. More...
std::unique_ptr< api::RoadNetwork >	CreateMultilaneRoadNetwork (const MultilaneBuildProperties &build_properties)
	Builds an api::RoadNetwork based on Multilane implementation. More...
std::unique_ptr< api::RoadNetwork >	CreateMalidriveRoadNetwork (const MalidriveBuildProperties &build_properties)
	Builds an api::RoadNetwork based on Malidrive implementation. More...
std::unique_ptr< api::RoadNetwork >	CreateMaliputOsmRoadNetwork (const MaliputOsmBuildProperties &build_properties)
	Builds an api::RoadNetwork based on MaliputOsm implementation. More...
std::unique_ptr< api::RoadNetwork >	LoadRoadNetwork (MaliputImplementation maliput_implementation, const DragwayBuildProperties &dragway_build_properties, const MultilaneBuildProperties &multilane_build_properties, const MalidriveBuildProperties &malidrive_build_properties, const MaliputOsmBuildProperties &maliput_osm_build_properties)
	Builds an api::RoadNetwork using the implementation that maliput_implementation describes. More...
std::string	GetResource (const MaliputImplementation &maliput_implementation, const std::string &resource_name)
	Obtains the correspondent path to the resource_name located at the maliput's implementation's resource directory if exists, otherwise it returns resource_name . More...

Enumeration Type Documentation

DynamicEnvironmentHandlerType

enum DynamicEnvironmentHandlerType

strong

Types of DynamicEnvironmentHandler implementations.

Enumerator
kFixedPhaseIterationHandler

MaliputImplementation

enum MaliputImplementation

strong

Available maliput implementations.

Enumerator
kMalidrive
kDragway
kMultilane
kOsm

TimerType

enum TimerType

strong

Timer implementations.

Enumerator
kChronoTimer

Function Documentation

CreateDragwayRoadNetwork()

std::unique_ptr< api::RoadNetwork > CreateDragwayRoadNetwork

(

const DragwayBuildProperties &

build_properties

)

Builds an api::RoadNetwork based on Dragway implementation.

Parameters

build_properties

Holds the properties to build the RoadNetwork.

Returns

A maliput::api::RoadNetwork.

CreateDynamicEnvironmentHandler()

std::unique_ptr<DynamicEnvironmentHandler> maliput::integration::CreateDynamicEnvironmentHandler	(	const DynamicEnvironmentHandlerType &	type,
		Args &&...	args
	)

Create Timer.

Parameters

type	A DynamicEnvironmentHandlerType.
args	Arguments to be forwarded to the selected implementation.

Returns

A DynamicEnvironmentHandler instance based on the selected implementation.

Template Parameters

Args	Type of the arguments to be forwarded to the selected implementation.

CreateMalidriveRoadNetwork()

std::unique_ptr< api::RoadNetwork > CreateMalidriveRoadNetwork

(

const MalidriveBuildProperties &

build_properties

)

Builds an api::RoadNetwork based on Malidrive implementation.

Parameters

build_properties

Holds the properties to build the RoadNetwork.

Returns

A maliput::api::RoadNetwork.

Exceptions

maliput::common::assertion_error

When build_properties.xodr_file_path is empty.

CreateMaliputOsmRoadNetwork()

std::unique_ptr< api::RoadNetwork > CreateMaliputOsmRoadNetwork

(

const MaliputOsmBuildProperties &

build_properties

)

Builds an api::RoadNetwork based on MaliputOsm implementation.

Parameters

build_properties

Holds the properties to build the RoadNetwork.

Returns

A maliput::api::RoadNetwork.

Exceptions

maliput::common::assertion_error

When build_properties.osm_file is empty.

CreateMultilaneRoadNetwork()

std::unique_ptr< api::RoadNetwork > CreateMultilaneRoadNetwork

(

const MultilaneBuildProperties &

build_properties

)

Builds an api::RoadNetwork based on Multilane implementation.

Parameters

build_properties

Holds the properties to build the RoadNetwork.

Returns

A maliput::api::RoadNetwork.

Exceptions

maliput::common::assertion_error

When build_properties.yaml_file is empty.

CreateTimer()

std::unique_ptr< Timer > CreateTimer

(

const TimerType &

type

)

Create Timer.

Parameters

type	A TimerType.

Returns

A Timer instance based on the selected implementation.

GetResource()

std::string GetResource	(	const MaliputImplementation &	maliput_implementation,
		const std::string &	resource_name
	)

Obtains the correspondent path to the resource_name located at the maliput's implementation's resource directory if exists, otherwise it returns resource_name .

Parameters

maliput_implementation	One of MaliputImplementation. (kDragway, kMultilane, kMalidrive).
resource_name	Name of the resource.

Returns

• resource_name when resource_name is an absolute path.
• The full path to resource_name when resource_name is relative path and it is found at the maliput's implementation's resource folder
• resource_name when resource_name is relative path but it isn't found at the malidrive resource folder.

LoadRoadNetwork()

std::unique_ptr< api::RoadNetwork > LoadRoadNetwork	(	MaliputImplementation	maliput_implementation,
		const DragwayBuildProperties &	dragway_build_properties,
		const MultilaneBuildProperties &	multilane_build_properties,
		const MalidriveBuildProperties &	malidrive_build_properties,
		const MaliputOsmBuildProperties &	maliput_osm_build_properties
	)

Builds an api::RoadNetwork using the implementation that maliput_implementation describes.

Parameters

maliput_implementation	One of MaliputImplementation. (kDragway, kMultilane, kMalidrive).
dragway_build_properties	Holds the properties to build a dragway RoadNetwork.
multilane_build_properties	Holds the properties to build a multilane RoadNetwork.
malidrive_build_properties	Holds the properties to build a malidrive RoadNetwork.
maliput_osm_build_properties	Holds the properties to build a maliput_osm RoadNetwork.

Returns

A maliput::api::RoadNetwork.

Exceptions

maliput::common::assertion_error

When maliput_implementation is unknown.

MaliputImplementationToString()

std::string MaliputImplementationToString

(

MaliputImplementation

maliput_impl

)

Returns the std::string version of maliput_impl.

StringToMaliputImplementation()

MaliputImplementation StringToMaliputImplementation

(

const std::string &

maliput_impl

)

Returns the MaliputImplementation version of maliput_impl.