maliput
maliput::plugin Namespace Reference

Classes

class  MaliputPlugin
 MaliputPlugin loads a dynamic library. More...
 
class  MaliputPluginManager
 Manages the lifecycle of MaliputPlugins. More...
 
class  RoadNetworkLoader
 Interface class for creating a RoadNetwork loader functor. More...
 

Typedefs

typedef void * RoadNetworkLoaderPtr
 Additional name for the MakeRoadNetworkLoader method's return type. More...
 

Enumerations

enum  MaliputPluginType { kRoadNetworkLoader }
 Types of maliput plugin. More...
 

Functions

std::unique_ptr< maliput::api::RoadNetworkCreateRoadNetwork (const std::string &road_network_loader_id, const std::map< std::string, std::string > &properties)
 Creates a maliput::api::RoadNetwork via RoadNetworkLoader plugin. More...
 
std::unique_ptr< maliput::plugin::RoadNetworkLoaderMakeRoadNetworkLoader (const std::string &road_network_loader_id)
 Creates a maliput::plugin::RoadNetworkLoader using the specified plugin id. More...
 

Typedef Documentation

◆ RoadNetworkLoaderPtr

typedef void* RoadNetworkLoaderPtr

Additional name for the MakeRoadNetworkLoader method's return type.

Enumeration Type Documentation

◆ MaliputPluginType

Types of maliput plugin.

Note: All function/enum that have extern "C" linkage share the same space of names. Although this enum is within maliput::plugin namespace you can't have any other extern "C" enum with name MaliputPluginType in any other namespace.

Enumerator
kRoadNetworkLoader 

Function Documentation

◆ CreateRoadNetwork()

std::unique_ptr< maliput::api::RoadNetwork > CreateRoadNetwork ( const std::string &  road_network_loader_id,
const std::map< std::string, std::string > &  properties 
)

Creates a maliput::api::RoadNetwork via RoadNetworkLoader plugin.

Parameters
road_network_loader_idRoadNetworkLoader plugin id to be used.
propertiesA dictionary containing configuration parameters for the road network builder.
Returns
A maliput::api::RoadNetwork.
Exceptions
maliput::common::assertion_errorWhen road_network_loader_id is not found.
maliput::common::assertion_errorWhen the plugin isn't a RoadNetworkLoader plugin type.
maliput::common::assertion_errorWhen the maliput::api::RoadNetwork can't be loaded.

◆ MakeRoadNetworkLoader()

std::unique_ptr< maliput::plugin::RoadNetworkLoader > MakeRoadNetworkLoader ( const std::string &  road_network_loader_id)

Creates a maliput::plugin::RoadNetworkLoader using the specified plugin id.

Parameters
road_network_loader_idRoadNetworkLoader plugin id to be used.
Returns
A maliput::plugin::RoadNetworkLoader.
Exceptions
maliput::common::assertion_errorWhen road_network_loader_id is not found.
maliput::common::assertion_errorWhen the plugin isn't a RoadNetworkLoader plugin type.