CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Public Attributes | List of all members
CartoType::TVehicleType Class Reference

#include <cartotype_navigation.h>

Public Member Functions

bool operator== (const TVehicleType &aOther) const
 
bool ObeysOneWay () const
 
bool WalkingAllowed () const
 
bool CyclingAllowed () const
 
void Normalize ()
 

Public Attributes

uint32_t iAccessFlags = KArcCarAccessFlag | KArcWrongWayFlag
 
double iWeight = 0
 
double iAxleLoad = 0
 
double iDoubleAxleLoad = 0
 
double iTripleAxleLoad = 0
 
double iHeight = 0
 
double iWidth = 0
 
double iLength = 0
 
bool iHazMat = false
 

Detailed Description

A vehicle type used in routing.

Member Function Documentation

◆ CyclingAllowed()

bool CartoType::TVehicleType::CyclingAllowed ( ) const
inline

True if cycling (access to cycle routes) is allowed.

◆ Normalize()

void CartoType::TVehicleType::Normalize ( )
inline

Normalizes the vehicle type: ensures that KArcOtherAccessFlag is set if and only if vehicle details are given, and that weights and dimensions are non-negative.

◆ ObeysOneWay()

bool CartoType::TVehicleType::ObeysOneWay ( ) const
inline

True if this vehicle type obeys one-way restrictions. Pedestrian types usually do not.

◆ operator==()

bool CartoType::TVehicleType::operator== ( const TVehicleType aOther) const
inline

The equality operator.

◆ WalkingAllowed()

bool CartoType::TVehicleType::WalkingAllowed ( ) const
inline

True if walking (access to pedestrian routes) is allowed.

Member Data Documentation

◆ iAccessFlags

uint32_t CartoType::TVehicleType::iAccessFlags = KArcCarAccessFlag | KArcWrongWayFlag

Flags taken from KArcWrongWayFlag ... KArcOtherAccessFlag indicating the vehicle type. Arcs with restrictions matching any of these flags will not be taken.

◆ iAxleLoad

double CartoType::TVehicleType::iAxleLoad = 0

The vehicle's axle load in metric tons. Values of zero or less mean 'unknown'.

◆ iDoubleAxleLoad

double CartoType::TVehicleType::iDoubleAxleLoad = 0

The vehicle's double axle load in metric tons. Values of zero or less mean 'unknown'.

◆ iHazMat

bool CartoType::TVehicleType::iHazMat = false

True if the vehicle is carrying hazardous materials.

◆ iHeight

double CartoType::TVehicleType::iHeight = 0

The vehicle's height in meters. Values of zero or less mean 'unknown'.

◆ iLength

double CartoType::TVehicleType::iLength = 0

The vehicle's length in meters. Values of zero or less mean 'unknown'.

◆ iTripleAxleLoad

double CartoType::TVehicleType::iTripleAxleLoad = 0

The vehicle's triple axle weight in metric tons. Values of zero or less mean 'unknown'.

◆ iWeight

double CartoType::TVehicleType::iWeight = 0

The vehicle's weight in metric tons. Values of zero or less mean 'unknown'.

◆ iWidth

double CartoType::TVehicleType::iWidth = 0

The vehicle's width in meters. Values of zero or less mean 'unknown'.


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