maliput_malidrive
Header Struct Reference

Detailed Description

Holds the values of a XODR description's header.

For example, a XML node describing a XODR's header:

<OpenDRIVE>
<header revMajor="1" revMinor="1" name="ExampleMap" version="1.00" date="Fri May 08 12:00:00 2020"
north="0.0000000000000000e+00" south="0.0000000000000000e+00" east="0.0000000000000000e+00"
west="0.0000000000000000e+00" vendor="VendorName">
</header>
...
...
</OpenDRIVE>

#include <src/maliput_malidrive/xodr/header.h>

Public Member Functions

bool operator== (const Header &other) const
 Equality operator. More...
 
bool operator!= (const Header &other) const
 Inequality operator. More...
 

Public Attributes

double rev_major {}
 Major revision number of Malidrive format. More...
 
double rev_minor {}
 Minor revision number of Malidrive format. More...
 
std::optional< std::string > name {std::nullopt}
 Database name. More...
 
std::optional< double > version {std::nullopt}
 Database's version number. More...
 
std::optional< std::string > date {std::nullopt}
 Time/date of database creation according to ISO 8601. More...
 
std::optional< double > north {std::nullopt}
 Maximum inertial y value. More...
 
std::optional< double > south {std::nullopt}
 Minimum inertial y value. More...
 
std::optional< double > east {std::nullopt}
 Maximum inertial x value. More...
 
std::optional< double > west {std::nullopt}
 Minimum inertial x value. More...
 
std::optional< std::string > vendor {std::nullopt}
 Vendor name. More...
 

Static Public Attributes

static constexpr const char * kHeaderTag = "header"
 Convenient constants that hold the tag names in the XODR header description. More...
 
static constexpr const char * kXodrRevMajor = "revMajor"
 
static constexpr const char * kXodrRevMinor = "revMinor"
 
static constexpr const char * kXodrName = "name"
 
static constexpr const char * kXodrVersion = "version"
 
static constexpr const char * kXodrDate = "date"
 
static constexpr const char * kXodrNorth = "north"
 
static constexpr const char * kXodrSouth = "south"
 
static constexpr const char * kXodrEast = "east"
 
static constexpr const char * kXodrWest = "west"
 
static constexpr const char * kXodrVendor = "vendor"
 

Member Function Documentation

◆ operator!=()

bool operator!= ( const Header other) const

Inequality operator.

◆ operator==()

bool operator== ( const Header other) const

Equality operator.

Member Data Documentation

◆ date

std::optional<std::string> date {std::nullopt}

Time/date of database creation according to ISO 8601.

TODO(francocipollone): Use std::chrono::system_clock::time_point instead of std::string.

◆ east

std::optional<double> east {std::nullopt}

Maximum inertial x value.

◆ kHeaderTag

constexpr const char* kHeaderTag = "header"
staticconstexpr

Convenient constants that hold the tag names in the XODR header description.

◆ kXodrDate

constexpr const char* kXodrDate = "date"
staticconstexpr

◆ kXodrEast

constexpr const char* kXodrEast = "east"
staticconstexpr

◆ kXodrName

constexpr const char* kXodrName = "name"
staticconstexpr

◆ kXodrNorth

constexpr const char* kXodrNorth = "north"
staticconstexpr

◆ kXodrRevMajor

constexpr const char* kXodrRevMajor = "revMajor"
staticconstexpr

◆ kXodrRevMinor

constexpr const char* kXodrRevMinor = "revMinor"
staticconstexpr

◆ kXodrSouth

constexpr const char* kXodrSouth = "south"
staticconstexpr

◆ kXodrVendor

constexpr const char* kXodrVendor = "vendor"
staticconstexpr

◆ kXodrVersion

constexpr const char* kXodrVersion = "version"
staticconstexpr

◆ kXodrWest

constexpr const char* kXodrWest = "west"
staticconstexpr

◆ name

std::optional<std::string> name {std::nullopt}

Database name.

◆ north

std::optional<double> north {std::nullopt}

Maximum inertial y value.

◆ rev_major

double rev_major {}

Major revision number of Malidrive format.

◆ rev_minor

double rev_minor {}

Minor revision number of Malidrive format.

◆ south

std::optional<double> south {std::nullopt}

Minimum inertial y value.

◆ vendor

std::optional<std::string> vendor {std::nullopt}

Vendor name.

◆ version

std::optional<double> version {std::nullopt}

Database's version number.

◆ west

std::optional<double> west {std::nullopt}

Minimum inertial x value.


The documentation for this struct was generated from the following files: