Inheritance diagram for gem::PTRouteSegment:

[legend]

Collaboration diagram for gem::PTRouteSegment:

[legend]

Public Member Functions
const StringRef	getName () const noexcept
	Get name.
const StringRef	getPlatformCode () const noexcept
	Get platform code.
const TimeRef	getArrivalTime () const noexcept
	Get arrival time.
const TimeRef	getDepartureTime () const noexcept
	Get departure time.
bool	getHasWheelchairSupport () const noexcept
	Get wheelchair support.
const StringRef	getShortName () const noexcept
	Get ShortName.
const StringRef	getRouteUrl () const noexcept
	Get route URL.
const StringRef	getAgencyName () const noexcept
	Get agency name.
const StringRef	getAgencyPhone () const noexcept
	Get agency phone.
const StringRef	getAgencyUrl () const noexcept
	Get agency URL.
const StringRef	getAgencyFareUrl () const noexcept
	Get agency fare URL.
const StringRef	getLineFrom () const noexcept
	Get line from.
const StringRef	getLineTowards () const noexcept
	Get line towards.
int	getArrivalDelayInSeconds () const noexcept
	Get arrival delay in seconds.
int	getDepartureDelayInSeconds () const noexcept
	Get departure delay in seconds.
bool	getHasBicycleSupport () const noexcept
	Get bicycle support.
bool	getStayOnSameTransit () const noexcept
	Get stay on same transit.
ETransitType	getTransitType () const noexcept
	Get transit type.
ERealtimeStatus	getRealtimeStatus () const noexcept
	Get realtime status.
int	getLineBlockID () const noexcept
	Get line block ID.
Rgba	getLineColor () const noexcept
	Get line color.
Rgba	getLineTextColor () const noexcept
	Get line text color.
int	getCountAlerts () const noexcept
	Get number of alerts for this PT information.
const PTAlertRef	getAlert (int index) const noexcept
	Get alert specified by index.
bool	isSignificant () const noexcept
	Return true if this is significant.
bool	isStationWalk () const noexcept
	Check if this is a station walk.
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.

Detailed Description

PTRouteSegment object.

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

Member Function Documentation

◆ getAgencyFareUrl()

const StringRef gem::PTRouteSegment::getAgencyFareUrl ( ) const

inlinenoexcept

Get agency fare URL.

Returns: Agency fare URL of the route segment.

◆ getAgencyName()

const StringRef gem::PTRouteSegment::getAgencyName ( ) const

inlinenoexcept

Get agency name.

Returns: Agency name of the route segment.

◆ getAgencyPhone()

const StringRef gem::PTRouteSegment::getAgencyPhone ( ) const

inlinenoexcept

Get agency phone.

Returns: Agency phone of the route segment.

◆ getAgencyUrl()

const StringRef gem::PTRouteSegment::getAgencyUrl ( ) const

inlinenoexcept

Get agency URL.

Returns: Agency URL of the route segment.

◆ getAlert()

const PTAlertRef gem::PTRouteSegment::getAlert ( int index ) const

inlinenoexcept

Get alert specified by index.

Parameters

index Index of the alert.

Returns: empty Index is out of bounds.

◆ getArrivalDelayInSeconds()

int gem::PTRouteSegment::getArrivalDelayInSeconds ( ) const

inlinenoexcept

Get arrival delay in seconds.

Returns: Arrival delay in seconds of the route segment.

◆ getArrivalTime()

const TimeRef gem::PTRouteSegment::getArrivalTime ( ) const

inlinenoexcept

Get arrival time.

Returns: Arrival time of the route segment.

◆ getCountAlerts()

int gem::PTRouteSegment::getCountAlerts ( ) const

inlinenoexcept

Get number of alerts for this PT information.

Returns: Number of alerts for the route segment.

◆ getDepartureDelayInSeconds()

int gem::PTRouteSegment::getDepartureDelayInSeconds ( ) const

inlinenoexcept

Get departure delay in seconds.

Returns: Departure delay in seconds of the route segment.

◆ getDepartureTime()

const TimeRef gem::PTRouteSegment::getDepartureTime ( ) const

inlinenoexcept

Get departure time.

Returns: Departure time of the route segment.

◆ getGeographicArea()

RectangleGeographicArea gem::RouteSegmentBase::getGeographicArea ( ) const

inlinenoexceptinherited

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.

◆ getHasBicycleSupport()

bool gem::PTRouteSegment::getHasBicycleSupport ( ) const

inlinenoexcept

Get bicycle support.

Returns: True if the route segment has bicycle support, false otherwise.

◆ getHasWheelchairSupport()

bool gem::PTRouteSegment::getHasWheelchairSupport ( ) const

inlinenoexcept

Get wheelchair support.

Returns: True if the route segment has wheelchair support, false otherwise.

◆ getIncursCosts()

bool gem::RouteSegmentBase::getIncursCosts ( ) const

inlinenoexceptinherited

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

inlinenoexceptinherited

Get route instructions list.

Returns: A list of route instructions for the route segment.

◆ getLineBlockID()

int gem::PTRouteSegment::getLineBlockID ( ) const

inlinenoexcept

Get line block ID.

Returns: Line block ID of the route segment.

◆ getLineColor()

Rgba gem::PTRouteSegment::getLineColor ( ) const

inlinenoexcept

Get line color.

Returns: Line color of the route segment.

◆ getLineFrom()

const StringRef gem::PTRouteSegment::getLineFrom ( ) const

inlinenoexcept

Get line from.

Returns: Line from of the route segment.

◆ getLineTextColor()

Rgba gem::PTRouteSegment::getLineTextColor ( ) const

inlinenoexcept

Get line text color.

Returns: Line text color of the route segment.

◆ getLineTowards()

const StringRef gem::PTRouteSegment::getLineTowards ( ) const

inlinenoexcept

Get line towards.

Returns: Line towards of the route segment.

◆ getName()

const StringRef gem::PTRouteSegment::getName ( ) const

inlinenoexcept

Get name.

Returns: Name of the route segment.

◆ getPlatformCode()

const StringRef gem::PTRouteSegment::getPlatformCode ( ) const

inlinenoexcept

Get platform code.

Returns: Platform code of the route segment.

◆ getRealtimeStatus()

ERealtimeStatus gem::PTRouteSegment::getRealtimeStatus ( ) const

inlinenoexcept

Get realtime status.

Returns: Realtime status of the route segment.

◆ getRouteUrl()

const StringRef gem::PTRouteSegment::getRouteUrl ( ) const

inlinenoexcept

Get route URL.

Returns: URL of the route segment.

◆ getShortName()

const StringRef gem::PTRouteSegment::getShortName ( ) const

inlinenoexcept

Get ShortName.

Returns: Short name of the route segment.

◆ getStayOnSameTransit()

bool gem::PTRouteSegment::getStayOnSameTransit ( ) const

inlinenoexcept

Get stay on same transit.

Returns: True if the route segment has stay on same transit, false otherwise.

◆ getSummary()

String gem::RouteSegmentBase::getSummary ( ) const

inlinenoexceptinherited

Get summary of the route segment.

Returns: A string containing the summary of the route segment.

◆ getTimeDistance()

TimeDistance gem::RouteSegmentBase::getTimeDistance ( ) const

inlinenoexceptinherited

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

inlinenoexceptinherited

Get segment toll sections.

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

◆ getTransitType()

ETransitType gem::PTRouteSegment::getTransitType ( ) const

inlinenoexcept

Get transit type.

Returns: Transit type of the route segment.

◆ getWaypoints()

LandmarkList gem::RouteSegmentBase::getWaypoints ( ) const

inlinenoexceptinherited

Get the list containing segment start and end waypoints.

Returns: A List of Landmarks along the route

◆ isCommon()

bool gem::RouteSegmentBase::isCommon ( ) const

inlinenoexceptinherited

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

inlinenoexceptinherited

Check if this instruction is part of an EV route.

Returns: True if it is an EV route, false otherwise.

◆ isSignificant()

bool gem::PTRouteSegment::isSignificant ( ) const

inlinenoexcept

Return true if this is significant.

(worth showing information about it)

Returns: True if this is significant, false otherwise.

◆ isStationWalk()

bool gem::PTRouteSegment::isStationWalk ( ) const

inlinenoexcept

Check if this is a station walk.

Returns: True if this is a station walk, false otherwise.

Public Member Functions

Detailed Description

Member Function Documentation

◆ getAgencyFareUrl()

◆ getAgencyName()

◆ getAgencyPhone()

◆ getAgencyUrl()

◆ getAlert()

◆ getArrivalDelayInSeconds()

◆ getArrivalTime()

◆ getCountAlerts()

◆ getDepartureDelayInSeconds()

◆ getDepartureTime()

◆ getGeographicArea()

◆ getHasBicycleSupport()

◆ getHasWheelchairSupport()

◆ getIncursCosts()

◆ getInstructions()

◆ getLineBlockID()

◆ getLineColor()

◆ getLineFrom()

◆ getLineTextColor()

◆ getLineTowards()

◆ getName()

◆ getPlatformCode()

◆ getRealtimeStatus()

◆ getRouteUrl()

◆ getShortName()

◆ getStayOnSameTransit()

◆ getSummary()

◆ getTimeDistance()

◆ getTollSections()

◆ getTransitType()

◆ getWaypoints()

◆ isCommon()

◆ isEV()

◆ isSignificant()

◆ isStationWalk()