maliput
HBounds Class Reference

Detailed Description

Bounds in the elevation dimension (h component) of a Lane-frame, consisting of a pair of minimum and maximum h value.

The bounds must straddle h = 0, i.e., the minimum must be <= 0 and the maximum must be >= 0.

#include <include/maliput/api/lane_data.h>

Public Member Functions

 HBounds ()=default
 Default constructor. More...
 
 HBounds (double min, double max)
 Fully parameterized constructor. More...
 

Getters and Setters

double min () const
 Gets minimum bound. More...
 
void set_min (double min)
 Sets minimum bound. More...
 
double max () const
 Gets maximum bound. More...
 
void set_max (double max)
 Sets maximum bound. More...
 

Constructor & Destructor Documentation

◆ HBounds() [1/2]

HBounds ( )
default

Default constructor.

◆ HBounds() [2/2]

HBounds ( double  min,
double  max 
)

Fully parameterized constructor.

Exceptions
maliput::common::assertion_errorWhen min is greater than 0.
maliput::common::assertion_errorWhen max is smaller than 0.

Member Function Documentation

◆ max()

double max ( ) const

Gets maximum bound.

◆ min()

double min ( ) const

Gets minimum bound.

◆ set_max()

void set_max ( double  max)

Sets maximum bound.

Exceptions
maliput::common::assertion_errorWhen max is smaller than 0.

◆ set_min()

void set_min ( double  min)

Sets minimum bound.

Exceptions
maliput::common::assertion_errorWhen min is greater than 0.

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