Drake
LaneDirection Struct Reference

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

#include <drake/automotive/lane_direction.h>

Collaboration diagram for LaneDirection:
[legend]

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...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 LaneDirection (const LaneDirection &)=default
 
LaneDirectionoperator= (const LaneDirection &)=default
 
 LaneDirection (LaneDirection &&)=default
 
LaneDirectionoperator= (LaneDirection &&)=default
 

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...
 

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.

Constructor & Destructor Documentation

LaneDirection ( const LaneDirection )
default
LaneDirection ( LaneDirection &&  )
default
LaneDirection ( )
inline

Default constructor.

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

A constructor that sets with_s to be true.

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

Fully parameterized constructor.

Member Function Documentation

LaneDirection& operator= ( const LaneDirection )
default
LaneDirection& operator= ( LaneDirection &&  )
default

Member Data Documentation

const maliput::api::Lane* lane {nullptr}
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: