delphyne
LaneDirection Struct Reference

Detailed Description

LaneDirection holds the lane that a MaliputRailcar is traversing and the direction in which it is moving.

A MaliputRailcar can either travel in the increasing-s direction or in the decreasing-s direction.

#include <src/systems/lane_direction.h>

Public Member Functions

 LaneDirection ()
 Default constructor. More...
 
 LaneDirection (const maliput::api::Lane *lane_input)
 A constructor that sets with_s to be true. More...
 
 LaneDirection (const maliput::api::Lane *lane_input, bool with_s_input)
 Fully parameterized constructor. More...
 

Public Attributes

const maliput::api::Lanelane {nullptr}
 
bool with_s {true}
 True means that the MaliputRailcar's s coordinate increases when the vehicle has positive speed. More...
 

Constructor & Destructor Documentation

◆ LaneDirection() [1/3]

Default constructor.

◆ LaneDirection() [2/3]

LaneDirection ( const maliput::api::Lane lane_input)
explicit

A constructor that sets with_s to be true.

◆ LaneDirection() [3/3]

LaneDirection ( const maliput::api::Lane lane_input,
bool  with_s_input 
)

Fully parameterized constructor.

Member Data Documentation

◆ lane

const maliput::api::Lane* lane {nullptr}

◆ with_s

bool with_s {true}

True means that the MaliputRailcar's s coordinate increases when the vehicle has positive speed.

False means the opposite.


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