Drake
loader.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <memory>
4 #include <string>
5 
6 namespace drake {
7 namespace maliput {
8 
9 namespace api {
10 class RoadGeometry;
11 }
12 
13 namespace multilane {
14 
15 /// @file
16 /// Loader for serialized multilane road networks.
17 ///
18 /// The serialization is a fairly straightforward mapping of the Builder
19 /// interface onto YAML. See (TBD) for more detail of the format.
20 ///
21 /// The basic idea is, however:
22 /// - general parameters (i.e., as supplied to Builder constructor)
23 /// - a collection of named 'points', which are specifications of explicitly
24 /// named Endpoints
25 /// - a collection of named 'connections', whose start Endpoints are specified
26 /// by reference to either a named Endpoint or the start or end of
27 /// a named Connection
28 /// - a collection of named 'groups', specified by sequences of named
29 /// Connections
30 ///
31 /// Parsing will fail if there is no way to concretely resolve all of the
32 /// Endpoint references, e.g., if a document specifies that Connection-A
33 /// is an arc starting at the end of Connection-B and that Connection-B
34 /// is an arc starting at the end of Connection-A. All referential chains
35 /// must bottom out in explicitly-named Endpoints.
36 // TODO(maddog@tri.global) Describe complete format somewhere.
37 
38 /// Loads the input string as a maliput_multilane_builder document.
39 std::unique_ptr<const api::RoadGeometry> Load(const std::string& input);
40 
41 /// Loads the named file as a maliput_multilane_builder document.
42 std::unique_ptr<const api::RoadGeometry> LoadFile(const std::string& filename);
43 
44 } // namespace multilane
45 } // namespace maliput
46 } // namespace drake
Definition: automotive_demo.cc:88
Definition: arc_road_curve.cc:11
std::unique_ptr< const api::RoadGeometry > LoadFile(const std::string &filename)
Loads the named file as a maliput_monolane_builder document.
Definition: loader.cc:235
std::unique_ptr< const api::RoadGeometry > Load(const std::string &input)
Loads the input string as a maliput_monolane_builder document.
Definition: loader.cc:230