gem::RouteSegmentBase Class Reference

RouteSegmentBase object. More...

Inheritance diagram for gem::RouteSegmentBase:

Collaboration diagram for gem::RouteSegmentBase:

Public Member Functions
LandmarkList	getWaypoints () const noexcept
	Get the list containing segment start and end waypoints.
TimeDistance	getTimeDistance () const noexcept
	Get length in meters and estimated travel time in seconds for the route / route segment.
RectangleGeographicArea	getGeographicArea () const noexcept
	Get geographic area of the route.
bool	getIncursCosts () const noexcept
	Method to check if traveling the route or route segment incurs cost to the user.
String	getSummary () const noexcept
	Get summary of the route segment.
RouteInstructionList	getInstructions () const noexcept
	Get route instructions list.
bool	isCommon () const noexcept
	Check if this segment is of common type.
bool	isEV () const noexcept
	Check if this instruction is part of an EV route.
TollSectionList	getTollSections () const noexcept
	Get segment toll sections.

Protected Member Functions
	RouteSegmentBase (const RouteSegmentBase &obj)=default
	Default copy constructor.
	RouteSegmentBase (RouteSegmentBase &&obj)=default
	Default move constructor noexcept is deduced.
RouteSegmentBase &	operator= (const RouteSegmentBase &obj)=default
	Default copy assignment.
RouteSegmentBase &	operator= (RouteSegmentBase &&obj)=default
	Default move assignment noexcept is deduced.

Friends
class	RouteSegment
class	PTRouteSegment

Detailed Description

RouteSegmentBase object.

Implements share-read / copy-on-write Api object over IRouteSegment.

Constructor & Destructor Documentation

RouteSegmentBase() [1/2]

gem::RouteSegmentBase::RouteSegmentBase ( const RouteSegmentBase & obj )

protecteddefault

Default copy constructor.

Parameters

obj	RouteSegmentBase to copy from.

RouteSegmentBase() [2/2]

gem::RouteSegmentBase::RouteSegmentBase ( RouteSegmentBase && obj )

protecteddefault

Default move constructor noexcept is deduced.

Parameters

obj	RouteSegmentBase to move from.

Member Function Documentation

getGeographicArea()

RectangleGeographicArea gem::RouteSegmentBase::getGeographicArea ( ) const

inlinenoexcept

Get geographic area of the route.

The geographic area is the smallest rectangle that can be drawn around the route.

Returns

Geographic area covered by the route, represented as a GeographicArea object.

getIncursCosts()

bool gem::RouteSegmentBase::getIncursCosts ( ) const

inlinenoexcept

Method to check if traveling the route or route segment incurs cost to the user.

Returns

True if the route incurs costs, false otherwise.

getInstructions()

RouteInstructionList gem::RouteSegmentBase::getInstructions ( ) const

inlinenoexcept

Get route instructions list.

Returns

A list of route instructions for the route segment.

getSummary()

String gem::RouteSegmentBase::getSummary ( ) const

inlinenoexcept

Get summary of the route segment.

Returns

A string containing the summary of the route segment.

getTimeDistance()

TimeDistance gem::RouteSegmentBase::getTimeDistance ( ) const

inlinenoexcept

Get length in meters and estimated travel time in seconds for the route / route segment.

Returns

Time and distance information for the route, encapsulated in a TimeDistance object.

getTollSections()

TollSectionList gem::RouteSegmentBase::getTollSections ( ) const

inlinenoexcept

Get segment toll sections.

Returns

The error code. On success, the toll sections are returned

getWaypoints()

LandmarkList gem::RouteSegmentBase::getWaypoints ( ) const

inlinenoexcept

Get the list containing segment start and end waypoints.

Returns

A List of Landmarks along the route

isCommon()

bool gem::RouteSegmentBase::isCommon ( ) const

inlinenoexcept

Check if this segment is of common type.

A common type route segment has the same travel mode as the parent route.

E.g. a walk segment in a public transport route has isCommon = false

Returns

True if the segment is common type, false otherwise.

isEV()

bool gem::RouteSegmentBase::isEV ( ) const

inlinenoexcept

Check if this instruction is part of an EV route.

Returns

True if it is an EV route, false otherwise.

operator=() [1/2]

RouteSegmentBase & gem::RouteSegmentBase::operator= ( const RouteSegmentBase & obj )

protecteddefault

Default copy assignment.

Parameters

obj	RouteSegmentBase to copy from.

Returns

RouteSegmentBase reference.

operator=() [2/2]

RouteSegmentBase & gem::RouteSegmentBase::operator= ( RouteSegmentBase && obj )

protecteddefault

Default move assignment noexcept is deduced.

Parameters

obj	RouteSegmentBase to move from.

Returns

RouteSegmentBase reference.