Inheritance diagram for gem::NavigationInstruction:

Collaboration diagram for gem::NavigationInstruction:

Public Member Functions
	NavigationInstruction (const NavigationInstruction &)=default
	Default copy constructor.
	NavigationInstruction (NavigationInstruction &&)=default
	Default move constructor noexcept is deduced.
NavigationInstruction &	operator= (const NavigationInstruction &instruction)=default
	Default copy assignment.
NavigationInstruction &	operator= (NavigationInstruction &&instruction)=default
	Default move assignment noexcept is deduced.
Route	getNavigationRoute () const noexcept
	Get the navigation session route to which the instruction belongs.
bool	hasSignpostInfo () const noexcept
	Check if signpost information is available.
const SignpostDetailsRef	getSignpostDetails () const noexcept
	Get the extended signpost details.
const StringRef	getSignpostInstruction () const noexcept
	Get the textual description for the signpost information.
TimeDistance	getTimeDistanceToNextTurn () const noexcept
	Get the distance to the next turn in meters, time in seconds.
TimeDistance	getRemainingTravelTimeDistance () const noexcept
	Get remaining travel distance in meters and remaining traveling time in seconds.
TimeDistance	getRemainingTravelTimeDistanceToNextWaypoint () const noexcept
	Get remaining traveling 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.
int	getNavigationStatus () const noexcept
	Get the navigation/simulation status, see ENavigationStatus.
const StringRef	getCurrentCountryCodeISO () const noexcept
	Get the ISO 3166-1 alpha-3 country code for the current navigation instruction.
double	getCurrentStreetSpeedLimit () const noexcept
	Get the maximum speed limit on the current street in meters per second.
NextSpeedLimit	getNextSpeedLimitVariation (int checkDistance=std::numeric_limits< int >::max()) const noexcept
	Get the next speed limit variation.
const StringRef	getCurrentStreetName () const noexcept
	Get the current street name.
const RoadInfoListRef	getCurrentRoadInformation () const noexcept
	Get the current road information.
const StringRef	getNextCountryCodeISO () const noexcept
	Get the ISO 3166-1 alpha-3 country code for the next navigation instruction.
const StringRef	getNextStreetName () const noexcept
	Get the next street name.
const RoadInfoListRef	getNextRoadInformation () const noexcept
	Get the next road information.
bool	hasNextTurnInfo () const noexcept
	Check if next turn information is available.
const ImageRef	getNextTurnImage () const noexcept
	Get the Schematic image of the next turn.
const TurnDetailsRef	getNextTurnDetails () const noexcept
	Get the full details for the next turn.
const StringRef	getNextTurnInstruction () const noexcept
	Get the textual description for the next turn.
const StringRef	getNextNextStreetName () const noexcept
	Get the next next street name.
bool	hasNextNextTurnInfo () const noexcept
	Check if next next turn information is available.
const RoadInfoListRef	getNextNextRoadInformation () const noexcept
	Get the next next road information.
const ImageRef	getNextNextTurnImage () const noexcept
	Get the Schematic image of the next next turn.
const StringRef	getNextNextTurnInstruction () const noexcept
	Get the textual description for the next next turn.
const RoadInfoImageRef	getRoadInfoImage (const RoadInfoList &list) const noexcept
	Get an image representation of given road info collection.
const LaneImageRef	getLaneImage () const noexcept
	Get an image representation of current lane configuration.
const TurnDetailsRef	getNextNextTurnDetails () const noexcept
	Get the full details for the next-next turn.
TimeDistance	getTimeDistanceToNextNextTurn () const noexcept
	Get the distance to the next-next turn in meters and time in seconds.
const sense::PositionPtr	getCurrentPosition () const noexcept
	Get the current position.
int	getSegmentIndex () const noexcept
	Get the index of the current route segment.
int	getInstructionIndex () const noexcept
	Get the index of the next route instruction on the current route segment.
RouteInstruction	getNextInstruction () const noexcept
	Get the next route instruction on the route.
RouteInstruction	getNextNextInstruction () const noexcept
	Get the next-next route instruction on the route.
RouteInstruction	getPreviousInstruction () const noexcept
	Get the previous route instruction on the route.
EDriveSide	getDriveSide () const noexcept
	Get drive side flag of the current traveled road.
float	getBatterySoC () const noexcept
	Get battery current SoC.
Coordinates	getReturnToRoutePosition () const noexcept
	Get closest position on navigation route when navigation is NS_WaitingReturnToRoute state.
AbstractGeometryImageRef	getReturnToRouteImage () const
	Get the turn image to closest position on navigation route when navigation is NS_WaitingReturnToRoute state.
DataBuffer	exportAs (int format) const noexcept
	Export navigation instruction.
bool	isNextTurnInProgress () const noexcept
	Check if next turn is in progress.
const TimeRef	getSwitchToNextRouteInstructionStamp () const noexcept
	Get switch to next route instruction time stamp.
EDriveSide	getNextWaypointDriveSide () const noexcept
	Get next waypoint drive side.

Detailed Description

NavigationInstruction object.

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

Member Function Documentation

◆ exportAs()

DataBuffer gem::NavigationInstruction::exportAs ( int format ) const

inlinenoexcept

Export navigation instruction.

Parameters

[in] format Data format, see EPathFileFormat

Returns: Instruction data buffer

◆ getBatterySoC()

float gem::NavigationInstruction::getBatterySoC ( ) const

inlinenoexcept

Get battery current SoC.

This will provide the estimated battery SoC for navigation on routes calculated with MotorVehicleProfile.fuel == FT_Electric

SoC is in the interval from 0.f ( empty battery ) to 1.f ( fully charged )

Returns: The battery SoC

◆ getCurrentCountryCodeISO()

const StringRef gem::NavigationInstruction::getCurrentCountryCodeISO ( ) const

inlinenoexcept

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

Empty string means no country. See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

Returns: The ISO 3166-1 alpha-3 country code for the current navigation instruction.

◆ getCurrentPosition()

const sense::PositionPtr gem::NavigationInstruction::getCurrentPosition ( ) const

inlinenoexcept

Get the current position.

Returns: The current position.

◆ getCurrentRoadInformation()

const RoadInfoListRef gem::NavigationInstruction::getCurrentRoadInformation ( ) const

inlinenoexcept

Get the current road information.

Returns: The current road information list reference

◆ getCurrentStreetName()

const StringRef gem::NavigationInstruction::getCurrentStreetName ( ) const

inlinenoexcept

Get the current street name.

Returns: The current street name.

◆ getCurrentStreetSpeedLimit()

double gem::NavigationInstruction::getCurrentStreetSpeedLimit ( ) const

inlinenoexcept

Get the maximum speed limit on the current street in meters per second.

Returns: 0 if maximum speed limit is not available

◆ getDriveSide()

EDriveSide gem::NavigationInstruction::getDriveSide ( ) const

inlinenoexcept

Get drive side flag of the current traveled road.

Returns: The drive side flag of the current traveled road

◆ getInstructionIndex()

int gem::NavigationInstruction::getInstructionIndex ( ) const

inlinenoexcept

Get the index of the next route instruction on the current route segment.

Returns: The index of the next route instruction on the current route segment.

◆ getLaneImage()

const LaneImageRef gem::NavigationInstruction::getLaneImage ( ) const

inlinenoexcept

Get an image representation of current lane configuration.

Return empty if no lane information is currently available

Returns: The lane image reference

◆ getNavigationRoute()

Route gem::NavigationInstruction::getNavigationRoute ( ) const

noexcept

Get the navigation session route to which the instruction belongs.

Returns: Route object to which the instruction belongs

◆ getNavigationStatus()

int gem::NavigationInstruction::getNavigationStatus ( ) const

inlinenoexcept

Get the navigation/simulation status, see ENavigationStatus.

Returns: The navigation/simulation status

◆ getNextCountryCodeISO()

const StringRef gem::NavigationInstruction::getNextCountryCodeISO ( ) const

inlinenoexcept

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

Empty string means no country. See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

Returns: The ISO 3166-1 alpha-3 country code for the next navigation instruction.

◆ getNextInstruction()

RouteInstruction gem::NavigationInstruction::getNextInstruction ( ) const

noexcept

Get the next route instruction on the route.

Returns: The next route instruction

◆ getNextNextInstruction()

RouteInstruction gem::NavigationInstruction::getNextNextInstruction ( ) const

noexcept

Get the next-next route instruction on the route.

Returns: The next-next route instruction

◆ getNextNextRoadInformation()

const RoadInfoListRef gem::NavigationInstruction::getNextNextRoadInformation ( ) const

inlinenoexcept

Get the next next road information.

Returns: The next next road information list reference

◆ getNextNextStreetName()

const StringRef gem::NavigationInstruction::getNextNextStreetName ( ) const

inlinenoexcept

Get the next next street name.

Returns: The next next street name.

◆ getNextNextTurnDetails()

const TurnDetailsRef gem::NavigationInstruction::getNextNextTurnDetails ( ) const

inlinenoexcept

Get the full details for the next-next turn.

This may be used instead of GetNextNextTurnIcon in order to customize turn display in UI.

Returns: The full details for the next-next turn.

◆ getNextNextTurnImage()

const ImageRef gem::NavigationInstruction::getNextNextTurnImage ( ) const

inlinenoexcept

Get the Schematic image of the next next turn.

A simplified representation of the next next turn image. A detailed representation can be obtained with getNextNextTurnDetails().getAbstractGeometryImage()

Returns: The Schematic image of the next next turn.

◆ getNextNextTurnInstruction()

const StringRef gem::NavigationInstruction::getNextNextTurnInstruction ( ) const

inlinenoexcept

Get the textual description for the next next turn.

Returns: The textual description for the next next turn.

◆ getNextRoadInformation()

const RoadInfoListRef gem::NavigationInstruction::getNextRoadInformation ( ) const

inlinenoexcept

Get the next road information.

Returns: The next road information list reference

◆ getNextSpeedLimitVariation()

NextSpeedLimit gem::NavigationInstruction::getNextSpeedLimitVariation ( int checkDistance = std::numeric_limits<int>::max() ) const

inlinenoexcept

Get the next speed limit variation.

Parameters

[in] checkDistance The speed limit variation search distance.

Set to std::numeric_limits<int>::max to use the maximum SDK internal distance

Returns: NextSpeedLimit if a speed limit variation was found

{ Coordinates(), 0, 0 } if speed limit doesn't change in the specified interval

{ Coordinates(), distance, 0 } if speed limit value changed from <value> to <not available>

Returns: The next speed limit variation

◆ getNextStreetName()

const StringRef gem::NavigationInstruction::getNextStreetName ( ) const

inlinenoexcept

Get the next street name.

Returns: The next street name.

◆ getNextTurnDetails()

const TurnDetailsRef gem::NavigationInstruction::getNextTurnDetails ( ) const

inlinenoexcept

Get the full details for the next turn.

This may be used instead of getNextTurnImage in order to customize turn display in UI.

Returns: The full details for the next turn.

◆ getNextTurnImage()

const ImageRef gem::NavigationInstruction::getNextTurnImage ( ) const

inlinenoexcept

Get the Schematic image of the next turn.

A simplified representation of the next turn image. A detailed representation can be obtained with getNextTurnDetails().getAbstractGeometryImage()

Returns: The Schematic image of the next turn.

◆ getNextTurnInstruction()

const StringRef gem::NavigationInstruction::getNextTurnInstruction ( ) const

inlinenoexcept

Get the textual description for the next turn.

Returns: The textual description for the next turn.

◆ getNextWaypointDriveSide()

EDriveSide gem::NavigationInstruction::getNextWaypointDriveSide ( ) const

inlinenoexcept

Get next waypoint drive side.

Returns: The drive side of the next waypoint ( destination ) in navigation

◆ getPreviousInstruction()

RouteInstruction gem::NavigationInstruction::getPreviousInstruction ( ) const

noexcept

Get the previous route instruction on the route.

Returns: The previous route instruction. If not available will return a default object

◆ getRemainingTravelTimeDistance()

TimeDistance gem::NavigationInstruction::getRemainingTravelTimeDistance ( ) const

inlinenoexcept

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

Returns: Remaining travel distance in meters and remaining traveling time in seconds.

◆ getRemainingTravelTimeDistanceToNextWaypoint()

TimeDistance gem::NavigationInstruction::getRemainingTravelTimeDistanceToNextWaypoint ( ) const

inlinenoexcept

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

Returns: Remaining traveling time in seconds to the next way point and the remaining travel distance in meters to the next way point.

◆ getReturnToRouteImage()

AbstractGeometryImageRef gem::NavigationInstruction::getReturnToRouteImage ( ) const

inline

Get the turn image to closest position on navigation route when navigation is NS_WaitingReturnToRoute state.

The image is valid only when navigation status is NS_WaitingReturnToRoute

Returns: The turn image to closest position on navigation route

◆ getReturnToRoutePosition()

Coordinates gem::NavigationInstruction::getReturnToRoutePosition ( ) const

inlinenoexcept

Get closest position on navigation route when navigation is NS_WaitingReturnToRoute state.

The position is valid only when navigation status is NS_WaitingReturnToRoute

Returns: The closest position on route coordinates

◆ getRoadInfoImage()

const RoadInfoImageRef gem::NavigationInstruction::getRoadInfoImage ( const RoadInfoList & list ) const

inlinenoexcept

Get an image representation of given road info collection.

Parameters

[in] list The road info list

Returns: The road info image reference

◆ getSegmentIndex()

int gem::NavigationInstruction::getSegmentIndex ( ) const

inlinenoexcept

Get the index of the current route segment.

Returns: The index of the current route segment.

◆ getSignpostDetails()

const SignpostDetailsRef gem::NavigationInstruction::getSignpostDetails ( ) const

inlinenoexcept

Get the extended signpost details.

Returns: The extended signpost details.

◆ getSignpostInstruction()

const StringRef gem::NavigationInstruction::getSignpostInstruction ( ) const

inlinenoexcept

Get the textual description for the signpost information.

Returns: The textual description for the signpost information.

◆ getSwitchToNextRouteInstructionStamp()

const TimeRef gem::NavigationInstruction::getSwitchToNextRouteInstructionStamp ( ) const

inlinenoexcept

Get switch to next route instruction time stamp.

Returns: The timestamp as universal time

◆ getTimeDistanceToNextNextTurn()

TimeDistance gem::NavigationInstruction::getTimeDistanceToNextNextTurn ( ) const

inlinenoexcept

Get the distance to the next-next turn in meters and time in seconds.

If there are no next next turn available, the time distance to next turn will be returned

Returns: The distance to the next-next turn in meters and time in seconds

◆ getTimeDistanceToNextTurn()

TimeDistance gem::NavigationInstruction::getTimeDistanceToNextTurn ( ) const

inlinenoexcept

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

Returns: The distance to the next turn in meters, time in seconds.

◆ getTraveledTimeDistance()

TimeDistance gem::NavigationInstruction::getTraveledTimeDistance ( ) const

inlinenoexcept

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

Returns: The traveled distance in meters and the traveled time in seconds.

◆ hasNextNextTurnInfo()

bool gem::NavigationInstruction::hasNextNextTurnInfo ( ) const

inlinenoexcept

Check if next next turn information is available.

Returns: True if next next turn information is available.

◆ hasNextTurnInfo()

bool gem::NavigationInstruction::hasNextTurnInfo ( ) const

inlinenoexcept

Check if next turn information is available.

Returns: True if next turn information is available.

◆ hasSignpostInfo()

bool gem::NavigationInstruction::hasSignpostInfo ( ) const

inlinenoexcept

Check if signpost information is available.

Returns: True if signpost information is available.

◆ isNextTurnInProgress()

bool gem::NavigationInstruction::isNextTurnInProgress ( ) const

inlinenoexcept

Check if next turn is in progress.

Returns: true if next turn is in execution state

◆ operator=() [1/2]

NavigationInstruction & gem::NavigationInstruction::operator= ( const NavigationInstruction & instruction )

default

Default copy assignment.

Parameters

instruction The NavigationInstruction object to assign

Returns: The assigned NavigationInstruction object

◆ operator=() [2/2]

NavigationInstruction & gem::NavigationInstruction::operator= ( NavigationInstruction && instruction )

default

Default move assignment noexcept is deduced.

Parameters

instruction The NavigationInstruction object to assign

Returns: The assigned NavigationInstruction object

Public Member Functions

Detailed Description

Member Function Documentation

◆ exportAs()

◆ getBatterySoC()

◆ getCurrentCountryCodeISO()

◆ getCurrentPosition()

◆ getCurrentRoadInformation()

◆ getCurrentStreetName()

◆ getCurrentStreetSpeedLimit()

◆ getDriveSide()

◆ getInstructionIndex()

◆ getLaneImage()

◆ getNavigationRoute()

◆ getNavigationStatus()

◆ getNextCountryCodeISO()

◆ getNextInstruction()

◆ getNextNextInstruction()

◆ getNextNextRoadInformation()

◆ getNextNextStreetName()

◆ getNextNextTurnDetails()

◆ getNextNextTurnImage()

◆ getNextNextTurnInstruction()

◆ getNextRoadInformation()

◆ getNextSpeedLimitVariation()

◆ getNextStreetName()

◆ getNextTurnDetails()

◆ getNextTurnImage()

◆ getNextTurnInstruction()

◆ getNextWaypointDriveSide()

◆ getPreviousInstruction()

◆ getRemainingTravelTimeDistance()

◆ getRemainingTravelTimeDistanceToNextWaypoint()

◆ getReturnToRouteImage()

◆ getReturnToRoutePosition()

◆ getRoadInfoImage()

◆ getSegmentIndex()

◆ getSignpostDetails()

◆ getSignpostInstruction()

◆ getSwitchToNextRouteInstructionStamp()

◆ getTimeDistanceToNextNextTurn()

◆ getTimeDistanceToNextTurn()

◆ getTraveledTimeDistance()

◆ hasNextNextTurnInfo()

◆ hasNextTurnInfo()

◆ hasSignpostInfo()

◆ isNextTurnInProgress()

◆ operator=() [1/2]

◆ operator=() [2/2]