Inheritance diagram for gem::RouteInstruction:

[legend]

Collaboration diagram for gem::RouteInstruction:

[legend]

Public Member Functions
	RouteInstruction (const RouteInstruction &inst)=default
	Default copy constructor.
	RouteInstruction (RouteInstruction &&inst)=default
	Default move constructor.
RouteInstruction &	operator= (const RouteInstruction &inst)=default
	Default copy assignment.
RouteInstruction &	operator= (RouteInstruction &&inst)=default
	Default move assignment noexcept is deduced.
bool	operator== (const RouteInstruction &inst) const
	Comparison operator equal.
bool	operator!= (const RouteInstruction &inst) const
	Comparison operator not equal.
const PTRouteInstructionRef	toPTRouteInstruction () const noexcept
	Convert to a PTRouteInstruction from this one.
const EVRouteInstructionRef	toEVRouteInstruction () const noexcept
	Convert to a EVRouteInstruction from this one.
bool	hasSignpostInfo () const noexcept
	Check if signpost information is available.
const SignpostDetailsRef	getSignpostDetails () const noexcept
	Get extended signpost details.
const StringRef	getSignpostInstruction () const noexcept
	Get textual description for the signpost information.
const AbstractGeometryImageRef	getRealisticNextTurnImage () const noexcept
	Get image for the realistic turn information.
TimeDistance	getTimeDistanceToNextTurn () const noexcept
	Get distance to the next turn in meters, time in seconds.
TimeDistance	getRemainingTravelTimeDistance () const noexcept
	Get remaining travel distance in meters and remaining travel time in seconds.
TimeDistance	getRemainingTravelTimeDistanceToNextWaypoint () const noexcept
	Get remaining travel time in seconds to the next way point and the remaining travel distance in meters to the next way point.
TimeDistance	getTraveledTimeDistance () const noexcept
	Get the traveled distance in meters and the traveled time in seconds.
const StringRef	getCountryCodeISO () const noexcept
	Get ISO 3166-1 alpha-3 country code for the navigation instruction.
bool	hasTurnInfo () const noexcept
	Check if turn information is available.
const ImageRef	getTurnImage () const noexcept
	Get turn image.
const TurnDetailsRef	getTurnDetails () const noexcept
	Get full details for the turn.
const StringRef	getTurnInstruction () const noexcept
	Get textual description for the turn.
bool	hasFollowRoadInfo () const noexcept
	Check if follow road information is available.
const StringRef	getFollowRoadInstruction () const noexcept
	Get textual description for the follow road information.
bool	hasRoadInfo () const noexcept
	Get if road information is available.
const RoadInfoListRef	getRoadInfo () const noexcept
	Get road information.
const RoadInfoImageRef	getRoadInfoImage () const noexcept
	Get road image.
const CoordinatesRef	getCoordinates () const noexcept
	Get coordinates for this route instruction.
bool	isExit () const noexcept
	Check if the route instruction is a main road exit instruction.
String	getExitDetails () const
	Get the exit route instruction text.
bool	isFerry () const noexcept
	Check if the route instruction is a ferry.
bool	isTollRoad () const noexcept
	Check if the route instruction is a toll road.
bool	isCommon () const noexcept
	Check if this instruction is of common type.
bool	isEV () const noexcept
	Check if this instruction is part of an EV route.

Protected Member Functions
bool	operator== (RouteInstructionBase const &item) const
	noexcept is deduced
bool	operator!= (RouteInstructionBase const &item) const
	Compare if the route instructions are not identical.

Detailed Description

RouteInstruction object.

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

Constructor & Destructor Documentation

◆ RouteInstruction() [1/2]

gem::RouteInstruction::RouteInstruction ( const RouteInstruction & inst )

default

Default copy constructor.

Parameters

inst	RouteInstruction to copy from.

◆ RouteInstruction() [2/2]

gem::RouteInstruction::RouteInstruction ( RouteInstruction && inst )

default

Default move constructor.

Parameters

inst	RouteInstruction to move from. noexcept is deduced

Member Function Documentation

◆ getCoordinates()

const CoordinatesRef gem::RouteInstructionBase::getCoordinates ( ) const

inlinenoexceptinherited

Get coordinates for this route instruction.

Returns: Coordinates of the instruction location.

◆ getCountryCodeISO()

const StringRef gem::RouteInstructionBase::getCountryCodeISO ( ) const

inlinenoexceptinherited

Get ISO 3166-1 alpha-3 country code for the navigation instruction.

Empty string means no country

Returns: StringRef Country ISO Code See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

◆ getExitDetails()

String gem::RouteInstructionBase::getExitDetails ( ) const

inlineinherited

Get the exit route instruction text.

If the instruction is not an exit, returns empty string and sets the API error to kNotFound

Returns: String that contains exit route instruction text

◆ getFollowRoadInstruction()

const StringRef gem::RouteInstructionBase::getFollowRoadInstruction ( ) const

inlinenoexceptinherited

Get textual description for the follow road information.

Returns: String containing the follow road instruction.

◆ getRealisticNextTurnImage()

const AbstractGeometryImageRef gem::RouteInstructionBase::getRealisticNextTurnImage ( ) const

inlinenoexceptinherited

Get image for the realistic turn information.

Returns: The image for the realistic next turn. The API user should check if the image is valid.

◆ getRemainingTravelTimeDistance()

TimeDistance gem::RouteInstructionBase::getRemainingTravelTimeDistance ( ) const

inlinenoexceptinherited

Get remaining travel distance in meters and remaining travel time in seconds.

Returns: TimeDistance structure containing the remaining travel time and distance.

◆ getRemainingTravelTimeDistanceToNextWaypoint()

TimeDistance gem::RouteInstructionBase::getRemainingTravelTimeDistanceToNextWaypoint ( ) const

inlinenoexceptinherited

Get remaining travel time in seconds to the next way point and the remaining travel distance in meters to the next way point.

Returns: TimeDistance structure containing the remaining distance and time to the next waypoint.

◆ getRoadInfo()

const RoadInfoListRef gem::RouteInstructionBase::getRoadInfo ( ) const

inlinenoexceptinherited

Get road information.

Returns: a ref to a list containing the road information.

◆ getRoadInfoImage()

const RoadInfoImageRef gem::RouteInstructionBase::getRoadInfoImage ( ) const

inlinenoexceptinherited

Get road image.

Returns: RoadInfo Image associated with the road information.

◆ getSignpostDetails()

const SignpostDetailsRef gem::RouteInstructionBase::getSignpostDetails ( ) const

inlinenoexceptinherited

Get extended signpost details.

Returns: Details of the signpost as a structured object reference.

◆ getSignpostInstruction()

const StringRef gem::RouteInstructionBase::getSignpostInstruction ( ) const

inlinenoexceptinherited

Get textual description for the signpost information.

Returns: getSignpostInstruction containing the signpost instructions.

◆ getTimeDistanceToNextTurn()

TimeDistance gem::RouteInstructionBase::getTimeDistanceToNextTurn ( ) const

inlinenoexceptinherited

Get distance to the next turn in meters, time in seconds.

Returns: TimeDistance structure containing time and distance values to the next turn.

◆ getTraveledTimeDistance()

TimeDistance gem::RouteInstructionBase::getTraveledTimeDistance ( ) const

inlinenoexceptinherited

Get the traveled distance in meters and the traveled time in seconds.

Returns: TimeDistance structure of traveled distance and time.

◆ getTurnDetails()

const TurnDetailsRef gem::RouteInstructionBase::getTurnDetails ( ) const

inlinenoexceptinherited

Get full details for the turn.

Returns: Full details for the turn. This may be used instead of 'getTurnImage' in order to customize display in UI.

◆ getTurnImage()

const ImageRef gem::RouteInstructionBase::getTurnImage ( ) const

inlinenoexceptinherited

Get turn image.

Returns: The image for the turn. The API user should check if the image is valid.

◆ getTurnInstruction()

const StringRef gem::RouteInstructionBase::getTurnInstruction ( ) const

inlinenoexceptinherited

Get textual description for the turn.

Returns: StringRef containing the turn instruction.

◆ hasFollowRoadInfo()

bool gem::RouteInstructionBase::hasFollowRoadInfo ( ) const

inlinenoexceptinherited

Check if follow road information is available.

Returns: True if follow road information is available, false otherwise.

◆ hasRoadInfo()

bool gem::RouteInstructionBase::hasRoadInfo ( ) const

inlinenoexceptinherited

Get if road information is available.

Returns: True if road information is available, false otherwise.

◆ hasSignpostInfo()

bool gem::RouteInstructionBase::hasSignpostInfo ( ) const

inlinenoexceptinherited

Check if signpost information is available.

Returns: True if signpost information is available, false otherwise.

◆ hasTurnInfo()

bool gem::RouteInstructionBase::hasTurnInfo ( ) const

inlinenoexceptinherited

Check if turn information is available.

Returns: True if turn information is available, false otherwise.

◆ isCommon()

bool gem::RouteInstructionBase::isCommon ( ) const

inlinenoexceptinherited

Check if this instruction is of common type.

A common type route instruction is part of a common type route segment, see RouteSegment::isCommon

Returns: True if instruction is common type, false otherwise.

◆ isEV()

bool gem::RouteInstructionBase::isEV ( ) const

inlinenoexceptinherited

Check if this instruction is part of an EV route.

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

◆ isExit()

bool gem::RouteInstructionBase::isExit ( ) const

inlinenoexceptinherited

Check if the route instruction is a main road exit instruction.

Returns: True if an exit is involved, false otherwise.

◆ isFerry()

bool gem::RouteInstructionBase::isFerry ( ) const

inlinenoexceptinherited

Check if the route instruction is a ferry.

Returns: True if a ferry is involved, false otherwise.

◆ isTollRoad()

bool gem::RouteInstructionBase::isTollRoad ( ) const

inlinenoexceptinherited

Check if the route instruction is a toll road.

Returns: True if a toll road is involved, false otherwise.

◆ operator!=() [1/2]

bool gem::RouteInstruction::operator!= ( const RouteInstruction & inst ) const

inline

Comparison operator not equal.

Returns: True if the route instructions are not identical, false otherwise.

Parameters

inst	RouteInstruction to compare with.

◆ operator!=() [2/2]

bool gem::RouteInstructionBase::operator!= ( RouteInstructionBase const & item ) const

inlineprotectedinherited

Compare if the route instructions are not identical.

Parameters

item	RouteInstructionBase to compare with.

Returns: True if the route instructions are not identical, false otherwise.

◆ operator=() [1/2]

RouteInstruction & gem::RouteInstruction::operator= ( const RouteInstruction & inst )

default

Default copy assignment.

Parameters

inst	RouteInstruction to copy from.

Returns: RouteInstruction reference.

◆ operator=() [2/2]

RouteInstruction & gem::RouteInstruction::operator= ( RouteInstruction && inst )

default

Default move assignment noexcept is deduced.

Parameters

inst	RouteInstruction to move from.

Returns: RouteInstruction reference.

◆ operator==() [1/2]

bool gem::RouteInstruction::operator== ( const RouteInstruction & inst ) const

inline

Comparison operator equal.

Returns: True if the route instructions are identical, false otherwise.

Parameters

inst	RouteInstruction to compare with.

◆ operator==() [2/2]

bool gem::RouteInstructionBase::operator== ( RouteInstructionBase const & item ) const

inlineprotectedinherited

noexcept is deduced

Compare if the route instructions are identical.

Parameters

item	RouteInstructionBase to compare with.

Returns: True if the route instructions are identical, false otherwise.

The comparison is done by calling the Equals method of the IRouteInstruction interface.

◆ toEVRouteInstruction()

const EVRouteInstructionRef gem::RouteInstruction::toEVRouteInstruction ( ) const

inlinenoexcept

Convert to a EVRouteInstruction from this one.

Returns: EVRouteInstruction reference.

◆ toPTRouteInstruction()

const PTRouteInstructionRef gem::RouteInstruction::toPTRouteInstruction ( ) const

inlinenoexcept

Convert to a PTRouteInstruction from this one.

Returns: PTRouteInstruction reference.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RouteInstruction() [1/2]

◆ RouteInstruction() [2/2]

Member Function Documentation

◆ getCoordinates()

◆ getCountryCodeISO()

◆ getExitDetails()

◆ getFollowRoadInstruction()

◆ getRealisticNextTurnImage()

◆ getRemainingTravelTimeDistance()

◆ getRemainingTravelTimeDistanceToNextWaypoint()

◆ getRoadInfo()

◆ getRoadInfoImage()

◆ getSignpostDetails()

◆ getSignpostInstruction()

◆ getTimeDistanceToNextTurn()

◆ getTraveledTimeDistance()

◆ getTurnDetails()

◆ getTurnImage()

◆ getTurnInstruction()

◆ hasFollowRoadInfo()

◆ hasRoadInfo()

◆ hasSignpostInfo()

◆ hasTurnInfo()

◆ isCommon()

◆ isEV()

◆ isExit()

◆ isFerry()

◆ isTollRoad()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ toEVRouteInstruction()

◆ toPTRouteInstruction()