Class Lane::Properties

Nested Relationships

This class is a nested type of Class Graph::Lane.

Class Documentation

class Properties

The Lane Properties class contains properties that apply across the full extent of the lane.

Public Functions

Properties()

Construct a default set of properties

  • speed_limit: nullopt

  • mutex_group: “”

std::optional<double> speed_limit() const

Get the speed limit along this lane. If a std::nullopt is returned, then there is no specified speed limit for the lane.

Properties &speed_limit(std::optional<double> value)

Set the speed limit along this lane. Providing a std::nullopt indicates that there is no speed limit for the lane.

const std::string &in_mutex_group() const

Get the mutex group that this lane is associated with. An empty string implies that it is not associated with any mutex group.

Only one robot at a time is allowed to occupy any waypoint or lane associated with a particular mutex group.

Properties &set_in_mutex_group(std::string group_name)

Set what mutex group this lane is associated with. Passing in an empty string will disassociate the lane from any mutex group.