Inheritance diagram for gem::Debug:

Collaboration diagram for gem::Debug:

Public Member Functions
	Debug (const Debug &)=delete
	Debug (Debug &&)=default
	Default move constructor noexcept is deduced.
Debug &	operator= (const Debug &)=delete
	Default copy assignment operator.
Debug &	operator= (Debug &&)=default
	Default move assignment noexcept is deduced.
void	log (ELogLevel level, char const pszModule, char const pszFunction, char const pszFile, int line, char const pszFrm,...) noexcept
	Print log via the SDK logging system.
void	log (ELogLevel level, char const pszModule, char const pszFunction, char const *pszFile, int line, String str,...) noexcept
	Print log via the SDK logging system.
LargeInteger	getUsedMemory () const noexcept
	Return memory used by the Sdk.
LargeInteger	getTotalMemory () const noexcept
	Return system total memory.
LargeInteger	getFreeMemory () const noexcept
	Return system free memory( this will include swap and kernel cache memory).
void	dumpMem (const String &Path, bool relative, bool checkUniqueStack=false) noexcept
	Dump current allocations.
void	breakOnAlloc (const String &file, int line, size_t allocationSize, bool breakOnce, ProgressListener listener) noexcept
	Break on allocation.
void	breakOnMaxAlloc (const LargeInteger &maxAlloc, ProgressListener listener) noexcept
	Break when RAM allocations exceed specified threshold.
void	resetMaxUsedMemory () const noexcept
	Sets MaxUsedMemory to current used memory.
LargeInteger	getMaxUsedMemory () const noexcept
	Return MaxUsedMemory.
MountInfoList	getAppIOInfo () const noexcept
	Get app I/O info.
TransferStatisticsRef	getDataAcquisitionTransferStats () const noexcept
	Get transfer statistics for data acquisition.
TransferStatisticsRef	getResourceUpdaterTransferStats () const noexcept
	Get transfer statistics for the resource updater service.
TransferStatisticsRef	getStatisticsTransferStats () const noexcept
	Get transfer statistics for the statistics service.
String	setRoutingDebugDumpPath (const String &path) const noexcept
	Set the path for dumping routing information.
void	getRoutingDebugDumpPaths (String &sTraffPenPath, String &sLinksPath, String &sFavLinksPath) const noexcept
	Retrieve the paths where routing information is dumped.
DataBuffer	dumpRoute (const Route &route, int options) const noexcept
	Dump route information with given options.
StringList	getDefUrls (int svc) const noexcept
	Get default URLs for the specified service.
StringList	getStyleBuilderUrls () const noexcept
	Get URLs for the style builder.
void	setCustomUrl (int svc, const String *url) const noexcept
	Set a custom URL for the specified service.
int	testUrl (const String &url, EHttpMethod method, const DataBuffer &post, ProgressListener listener) const noexcept
	Test a URL with the specified HTTP method and post data.
void	setRouteName (const String &name) const noexcept
	Set a name for a route for debugging purposes.
void	setRoutingAlgoModifiers (int modifiers) const noexcept
	Set modifiers for the routing algorithm to alter its behavior.
int	getRoutingAlgoModifiers () const noexcept
	Retrieve current routing algorithm modifiers.
int	getDijkstraProgress (MarkerList &links, IntList &types, MarkerList &meets, MarkerList &stations, ProgressListener listener) const noexcept
	Retrieve progress information for Dijkstra's algorithm.
MarkerCollection	getRouteConnections (const IRoute &route) const noexcept
	Retrieve connections for a given route as markers.
void	setNavigationModifiers (int modifiers) const noexcept
	Set modifiers for navigation locations.
int	getNavigationModifiers () const noexcept
	Retrieve the current navigation location modifiers.
int	getNavigationStateInfo (int state,...) const noexcept
	Get detailed navigation state information.
int	checkBetterRoute () const noexcept
	Initiate a check for a better route.
int	checkTrafficAlongRoutes () const noexcept
	Initiate a check for traffic conditions along all routes.
int	timeToBetterRouteSec () const noexcept
	Get the remaining time until the next check for a better route.
int	timeToCheckTrafficAlongRoutesSec () const noexcept
	Get the remaining time until the next check for traffic conditions along all routes.
Route	testRerouting (const Coordinates &dep, ETestRerouteStartDirection dir) const noexcept
	Test rerouting from the given coordinates on the closest route.
void	manyToManyPedestrianCalculation (const Coordinates &dep, const Coordinates &dest) const noexcept
	Perform a many-to-many pedestrian routing calculation.
void	oneToOnePedestrianCalculation (const Coordinates &dep, const Coordinates &dest) const noexcept
	Perform a one-to-one pedestrian routing calculation.
void	reshapeTracks (ProgressListener opProgress, const RoutePreferences &prefs, const String &path) const noexcept
	Reshape tracks from a given folder using specified route preferences.
int	generateAndReloadTrafficAndRoutingSettings () const noexcept
	Generate and reload traffic and routing settings.
Time	getAuthorizationExpireDate () const noexcept
	Retrieve the expiration date of the API authorization token.
void	getAppIconIds (IntList &ids, StringList &idsStr) const noexcept
	Retrieve application icon IDs and their string representations.
void	getAppStringsList (StringList &ids, StringList &strs) const noexcept
	Retrieve application string IDs and their corresponding strings.
void	generateGPSLog (bool generate) const noexcept
	Toggle the generation of a GPS log.
IntList	getServicesIds () const noexcept
	Retrieve a list of service IDs used within the application.
String	getServiceName (int id) const noexcept
	Retrieve the name of a service given its ID.
int	saveBitmap (IBitmap &bmp, const String &path, int format=IFF_Bmp) const noexcept
	Save a bitmap to a file.
int	saveBitmap (IBitmap &bmp, DataBuffer &buff, int format) const noexcept
	Save a bitmap to a data buffer.
Image	getImageFromBitmap (const DataBuffer &buff, const Size &sz, EImagePixelFormat format) const noexcept
	Retrieve an image from a memory bitmap.
int	saveImage (const Image &img, DataBuffer &buff) const noexcept
	Get the image internal data from an image object.
int	saveStyle (const String &jsonPath, const String &name, const String &nameRef, const DataBuffer &previewJpg, const Size &szPreview, int majorVer, int minorVer, bool highRes, const ParameterList &params, bool publish) const noexcept
	Save a style definition to a JSON path.
int	rejectStyle (const String &name, int majorVer, int minorVer, bool highRes) const noexcept
	Reject a previously saved style.
weather::LocationForecast	getAllWeatherConditions () const noexcept
	Retrieve all weather conditions parsed from all available resources.
int	sendTopicNotification (const String &topic, const String &message, bool sendByHTTPService) const noexcept
	Send a notification message on a specific topic.
void	importSiblingBookmarks (RouteBookmarks &bookmark) const noexcept
	Import all sibling bookmarks into a destination bookmark.
void	refreshContentStore () const noexcept
	Refresh the content store by loading external changes from disk.
int	startSimulationPresentation (ERouteTransportMode transport, const Coordinates &start, const Coordinates &end, MapView &view, ProgressListener listener, const Animation &animation=Animation()) noexcept
	Start a simulation presentation by calculating a predefined route, starting a simulation, and setting progress to 50%.
int	stopSimulationPresentation () noexcept
	Stop the current simulation presentation.
void	cleanupSocialCache () const noexcept
	Clean up the local cache of social data.
int	updateMaps (bool allowPartial=true) const noexcept
	Update maps to the latest version synchronously.
bool	isMainThread () const noexcept
	Check if the current thread is the main thread.
int	replayStreamActivityLog (const String &logPath) const noexcept
	Replay a previously recorded stream activity log.
void	setSDKProfile (int options, ProfileListener listener=ProfileListener()) noexcept
	Enable SDK profile options.
int	GetSDKProfile () const noexcept
	Retrieve the current SDK profile options.
int	getMapViewMaxZoomRanges () const noexcept
	Retrieve the maximum zoom ranges allowed on a MapView.
int	getMapViewCurrentZoomRange (const MapView &mapView) const noexcept
	Retrieve the MapView current zoom ranges.
int	enableRawPositionTracker (bool enable, const SceneObjectDataList &data) noexcept
	enable raw position tracker object
bool	isRawPositionTrackerEnabled () const noexcept
	check if raw position tracker is enabled
std::pair< int, String >	getSocialLabelsAppVariant () const noexcept
	get app variant for social labels
bool	isValidUUIDv4 (const String &uuid) const noexcept
	validate an uuid v4 string
String	generateUUIDv4 () const noexcept
	generate an uuid v4 string
bool	isOfflineFunctionalityAllowed () const noexcept
	Check offline functionality allowance.
int	corruptContent (const ContentStoreItem &item) const noexcept
	Corrupt content item file for testing purposes.
void	simulateOnSdkActivationAboutToExpire (gem::ESdkActivationAboutToExpireReason reason, gem::LargeInteger remainingTimeInSeconds) const noexcept
	Simulate SDK activation about to expire notification.

Detailed Description

Debug object.

Implements share-read / write Api object over IDebug.

This behaves like a singleton, i.e. all instances are shared behind the same API interface

Member Function Documentation

◆ breakOnAlloc()

void gem::Debug::breakOnAlloc	(	const String &	file,
		int	line,
		size_t	allocationSize,
		bool	breakOnce,
		ProgressListener	listener )

inlinenoexcept

Break on allocation.

Parameters

[in]	file	The file name to associate with the breakpoint.
[in]	line	The line number to associate with the breakpoint.
[in]	allocationSize	The size of the allocation to break on.
[in]	breakOnce	If true, the breakpoint will only trigger once.
[in]	listener	A listener to handle progress updates.

◆ breakOnMaxAlloc()

void gem::Debug::breakOnMaxAlloc	(	const LargeInteger &	maxAlloc,
		ProgressListener	listener )

inlinenoexcept

Break when RAM allocations exceed specified threshold.

Parameters

[in]	maxAlloc	The maximum allocated memory threshold.
[in]	listener	A listener to handle progress updates.

◆ checkBetterRoute()

int gem::Debug::checkBetterRoute ( ) const

inlinenoexcept

Initiate a check for a better route.

Returns: True if a better route is found, otherwise false.

◆ checkTrafficAlongRoutes()

int gem::Debug::checkTrafficAlongRoutes ( ) const

inlinenoexcept

Initiate a check for traffic conditions along all routes.

Returns: True if traffic conditions suggest a change in the route, otherwise false.

◆ corruptContent()

int gem::Debug::corruptContent ( const ContentStoreItem & item ) const

inlinenoexcept

Corrupt content item file for testing purposes.

Parameters

[in] item The content store item to be corrupted.

Returns: An error code indicating the success or failure of the operation.

◆ dumpMem()

void gem::Debug::dumpMem	(	const String &	Path,
		bool	relative,
		bool	checkUniqueStack = false )

inlinenoexcept

Dump current allocations.

Enabling checkStackUnicity will generate a much larger result

Parameters

[in]	Path	The path where the memory dump will be stored.
[in]	relative	If true, the path is relative; otherwise, it is absolute.
[in]	checkUniqueStack	If true, performs a check for unique stack traces.

◆ dumpRoute()

DataBuffer gem::Debug::dumpRoute	(	const Route &	route,
		int	options ) const

inlinenoexcept

Dump route information with given options.

Parameters

[in]	route	The route to be dumped.
[in]	options	Options defining what information to include in the dump.

Returns: A DataBuffer containing the dumped route information.

◆ enableRawPositionTracker()

int gem::Debug::enableRawPositionTracker	(	bool	enable,
		const SceneObjectDataList &	data )

inlinenoexcept

enable raw position tracker object

Parameters

[in]	enable	If true, enables the raw position tracker; if false, disables it.
[in]	data	The scene object data list to be used when enabling the raw position tracker.

Returns: An error code indicating the success or failure of the operation.

◆ generateAndReloadTrafficAndRoutingSettings()

int gem::Debug::generateAndReloadTrafficAndRoutingSettings ( ) const

inlinenoexcept

Generate and reload traffic and routing settings.

Returns: An error code indicating the success or failure of the operation.

◆ generateGPSLog()

void gem::Debug::generateGPSLog ( bool generate ) const

inlinenoexcept

Toggle the generation of a GPS log.

Parameters

[in] generate If true, starts generating a GPS log; if false, stops it.

◆ generateUUIDv4()

String gem::Debug::generateUUIDv4 ( ) const

inlinenoexcept

generate an uuid v4 string

Returns: A newly generated UUID v4 string.

◆ getAllWeatherConditions()

weather::LocationForecast gem::Debug::getAllWeatherConditions ( ) const

inlinenoexcept

Retrieve all weather conditions parsed from all available resources.

Returns: A weather::LocationForecast object containing all the parsed weather conditions.

◆ getAppIconIds()

void gem::Debug::getAppIconIds	(	IntList &	ids,
		StringList &	idsStr ) const

inlinenoexcept

Retrieve application icon IDs and their string representations.

Parameters

[out]	ids	List of icon IDs.
[out]	idsStr	List of string representations corresponding to the icon IDs.

◆ getAppIOInfo()

MountInfoList gem::Debug::getAppIOInfo ( ) const

inlinenoexcept

Get app I/O info.

Returns: A list of MountInfo structures, each providing details about a different storage mount point used by the application

◆ getAppStringsList()

void gem::Debug::getAppStringsList	(	StringList &	ids,
		StringList &	strs ) const

inlinenoexcept

Retrieve application string IDs and their corresponding strings.

Parameters

[out]	ids	List of string IDs.
[out]	strs	List of strings corresponding to the string IDs.

◆ getAuthorizationExpireDate()

Time gem::Debug::getAuthorizationExpireDate ( ) const

inlinenoexcept

Retrieve the expiration date of the API authorization token.

Returns: Time object representing the expiration date and time.

◆ getDataAcquisitionTransferStats()

TransferStatisticsRef gem::Debug::getDataAcquisitionTransferStats ( ) const

inlinenoexcept

Get transfer statistics for data acquisition.

Returns: A reference to the TransferStatistics object for data acquisition.

◆ getDefUrls()

StringList gem::Debug::getDefUrls ( int svc ) const

inlinenoexcept

Get default URLs for the specified service.

Parameters

[in] svc Service identifier for which URLs are requested.

Returns: A list of URLs configured for the specified service.

◆ getDijkstraProgress()

int gem::Debug::getDijkstraProgress	(	MarkerList &	links,
		IntList &	types,
		MarkerList &	meets,
		MarkerList &	stations,
		ProgressListener	listener ) const

inlinenoexcept

Retrieve progress information for Dijkstra's algorithm.

Parameters

[out]	links	List of links processed by the algorithm.
[out]	types	List of types for each link.
[out]	meets	List of meeting points in the algorithm.
[out]	stations	List of stations processed by the algorithm.
[in]	listener	A listener to handle progress updates.

Returns: An error code indicating the success or failure of the operation.

◆ getFreeMemory()

LargeInteger gem::Debug::getFreeMemory ( ) const

inlinenoexcept

Return system free memory( this will include swap and kernel cache memory).

Returns: The free memory in bytes.

◆ getImageFromBitmap()

Image gem::Debug::getImageFromBitmap	(	const DataBuffer &	buff,
		const Size &	sz,
		EImagePixelFormat	format ) const

inlinenoexcept

Retrieve an image from a memory bitmap.

Parameters

[in]	buff	The data buffer containing the bitmap data.
[in]	sz	The size of the image to retrieve.
[in]	format	The pixel format of the image.

Returns: An Image object created from the bitmap.

◆ getMapViewCurrentZoomRange()

int gem::Debug::getMapViewCurrentZoomRange ( const MapView & mapView ) const

inlinenoexcept

Retrieve the MapView current zoom ranges.

Parameters

[in] mapView The MapView object for which to retrieve the current zoom ranges.

Returns: The current zoom ranges for the specified MapView.

◆ getMapViewMaxZoomRanges()

int gem::Debug::getMapViewMaxZoomRanges ( ) const

inlinenoexcept

Retrieve the maximum zoom ranges allowed on a MapView.

Returns: The maximum zoom ranges for MapView.

◆ getMaxUsedMemory()

LargeInteger gem::Debug::getMaxUsedMemory ( ) const

inlinenoexcept

Return MaxUsedMemory.

Returns: The maximum used memory in bytes.

◆ getNavigationModifiers()

int gem::Debug::getNavigationModifiers ( ) const

inlinenoexcept

Retrieve the current navigation location modifiers.

Returns: Current set of navigation location modifiers as a bitwise OR.

◆ getNavigationStateInfo()

int gem::Debug::getNavigationStateInfo	(	int	state,
			... ) const

inlinenoexcept

Get detailed navigation state information.

Parameters

[in]	state	The state information to retrieve.
[in]	...	Variadic parameters providing context for the state information requested.

Returns: Detailed state information based on the provided state identifier.

◆ getResourceUpdaterTransferStats()

TransferStatisticsRef gem::Debug::getResourceUpdaterTransferStats ( ) const

inlinenoexcept

Get transfer statistics for the resource updater service.

Returns: A reference to the TransferStatistics object for the resource updater.

◆ getRouteConnections()

MarkerCollection gem::Debug::getRouteConnections ( const IRoute & route ) const

inlinenoexcept

Retrieve connections for a given route as markers.

Parameters

[in] route The route for which connections are to be retrieved.

Returns: A collection of markers representing the connections of the route.

◆ getRoutingAlgoModifiers()

int gem::Debug::getRoutingAlgoModifiers ( ) const

inlinenoexcept

Retrieve current routing algorithm modifiers.

Returns: Current set of modifiers as a bitwise OR of routing algorithm modifiers.

◆ getRoutingDebugDumpPaths()

void gem::Debug::getRoutingDebugDumpPaths	(	String &	sTraffPenPath,
		String &	sLinksPath,
		String &	sFavLinksPath ) const

inlinenoexcept

Retrieve the paths where routing information is dumped.

Parameters

[out]	sTraffPenPath	Path where traffic penalties are dumped.
[out]	sLinksPath	Path where links are dumped.
[out]	sFavLinksPath	Path where favorite links are dumped.

◆ GetSDKProfile()

int gem::Debug::GetSDKProfile ( ) const

inlinenoexcept

Retrieve the current SDK profile options.

Returns: The current bitmask of options enabled for the SDK profile.

◆ getServiceName()

String gem::Debug::getServiceName ( int id ) const

inlinenoexcept

Retrieve the name of a service given its ID.

Parameters

[in] id The ID of the service.

Returns: The name of the service corresponding to the provided ID.

◆ getServicesIds()

IntList gem::Debug::getServicesIds ( ) const

inlinenoexcept

Retrieve a list of service IDs used within the application.

Returns: A list of integer IDs representing the services.

◆ getSocialLabelsAppVariant()

std::pair< int, String > gem::Debug::getSocialLabelsAppVariant ( ) const

inlinenoexcept

get app variant for social labels

Returns: A pair containing the app variant as an integer and its string representation.

◆ getStatisticsTransferStats()

TransferStatisticsRef gem::Debug::getStatisticsTransferStats ( ) const

inlinenoexcept

Get transfer statistics for the statistics service.

Returns: A reference to the TransferStatistics object for statistics.

◆ getStyleBuilderUrls()

StringList gem::Debug::getStyleBuilderUrls ( ) const

inlinenoexcept

Get URLs for the style builder.

Returns: A list of URLs configured for the style builder.

◆ getTotalMemory()

LargeInteger gem::Debug::getTotalMemory ( ) const

inlinenoexcept

Return system total memory.

Returns: The total memory in bytes.

◆ getUsedMemory()

LargeInteger gem::Debug::getUsedMemory ( ) const

inlinenoexcept

Return memory used by the Sdk.

Returns: The used memory in bytes.

◆ importSiblingBookmarks()

void gem::Debug::importSiblingBookmarks ( RouteBookmarks & bookmark ) const

inlinenoexcept

Import all sibling bookmarks into a destination bookmark.

Parameters

[in,out] bookmark The destination bookmark into which siblings will be imported.

◆ isMainThread()

bool gem::Debug::isMainThread ( ) const

inlinenoexcept

Check if the current thread is the main thread.

Returns: True if the current thread is the main thread, otherwise false.

◆ isOfflineFunctionalityAllowed()

bool gem::Debug::isOfflineFunctionalityAllowed ( ) const

inlinenoexcept

Check offline functionality allowance.

Returns: True if offline functionality is allowed, otherwise false.

◆ isRawPositionTrackerEnabled()

bool gem::Debug::isRawPositionTrackerEnabled ( ) const

inlinenoexcept

check if raw position tracker is enabled

Returns: True if the raw position tracker is enabled, otherwise false.

◆ isValidUUIDv4()

bool gem::Debug::isValidUUIDv4 ( const String & uuid ) const

inlinenoexcept

validate an uuid v4 string

Parameters

[in] uuid The UUID string to validate.

Returns: True if the provided string is a valid UUID v4, otherwise false.

◆ log() [1/2]

void gem::Debug::log	(	ELogLevel	level,
		char const *	pszModule,
		char const *	pszFunction,
		char const *	pszFile,
		int	line,
		char const *	pszFrm,
			... )

inlinenoexcept

Print log via the SDK logging system.

Parameters

[in]	level	The severity level of the log.
[in]	pszModule	The module from which the log is coming.
[in]	pszFunction	The function from which the log is issued.
[in]	pszFile	The file from which the log is issued.
[in]	line	The line number in the file at which the log is issued.
[in]	pszFrm	The format string for the log message, similar to printf.
[in]	...	Variadic arguments providing values for the format string placeholders.

◆ log() [2/2]

void gem::Debug::log	(	ELogLevel	level,
		char const *	pszModule,
		char const *	pszFunction,
		char const *	pszFile,
		int	line,
		String	str,
			... )

inlinenoexcept

Print log via the SDK logging system.

Parameters

[in]	level	The severity level of the log.
[in]	pszModule	The module from which the log is coming.
[in]	pszFunction	The function from which the log is issued.
[in]	pszFile	The file from which the log is issued.
[in]	line	The line number in the file at which the log is issued.
[in]	str	The format string for the log message, similar to printf.
[in]	...	Variadic arguments providing values for the format string placeholders.

◆ manyToManyPedestrianCalculation()

void gem::Debug::manyToManyPedestrianCalculation	(	const Coordinates &	dep,
		const Coordinates &	dest ) const

inlinenoexcept

Perform a many-to-many pedestrian routing calculation.

Parameters

[in]	dep	Coordinates of the departure point.
[in]	dest	Coordinates of the destination.

◆ oneToOnePedestrianCalculation()

void gem::Debug::oneToOnePedestrianCalculation	(	const Coordinates &	dep,
		const Coordinates &	dest ) const

inlinenoexcept

Perform a one-to-one pedestrian routing calculation.

Parameters

[in]	dep	Coordinates of the departure point.
[in]	dest	Coordinates of the destination.

◆ operator=() [1/2]

Debug & gem::Debug::operator= ( const Debug & )

delete

Default copy assignment operator.

Returns: A reference to the modified Debug object.

◆ operator=() [2/2]

Debug & gem::Debug::operator= ( Debug && )

default

Default move assignment noexcept is deduced.

Returns: A reference to the modified Debug object.

◆ rejectStyle()

int gem::Debug::rejectStyle	(	const String &	name,
		int	majorVer,
		int	minorVer,
		bool	highRes ) const

inlinenoexcept

Reject a previously saved style.

Parameters

[in]	name	The name of the style to reject.
[in]	majorVer	The major version number of the style to reject.
[in]	minorVer	The minor version number of the style to reject.
[in]	highRes	A flag indicating whether the rejected style is high resolution.

Returns: An error code indicating the success or failure of the operation.

◆ replayStreamActivityLog()

int gem::Debug::replayStreamActivityLog ( const String & logPath ) const

inlinenoexcept

Replay a previously recorded stream activity log.

Parameters

[in] logPath The path to the log file to be replayed.

Returns: An error code indicating the success or failure of the operation.

◆ reshapeTracks()

void gem::Debug::reshapeTracks	(	ProgressListener	opProgress,
		const RoutePreferences &	prefs,
		const String &	path ) const

inlinenoexcept

Reshape tracks from a given folder using specified route preferences.

Parameters

[in]	opProgress	A listener to handle operation progress.
[in]	prefs	Route preferences to use for reshaping tracks.
[in]	path	Path to the folder containing tracks to be reshaped.

◆ saveBitmap() [1/2]

int gem::Debug::saveBitmap	(	IBitmap &	bmp,
		const String &	path,
		int	format = IFF_Bmp ) const

inlinenoexcept

Save a bitmap to a file.

Parameters

[in]	bmp	The bitmap to save.
[in]	path	The file path where the bitmap should be saved.
[in]	format	The image format in which to save the bitmap.

Returns: An error code indicating the success or failure of the operation.

◆ saveBitmap() [2/2]

int gem::Debug::saveBitmap	(	IBitmap &	bmp,
		DataBuffer &	buff,
		int	format ) const

inlinenoexcept

Save a bitmap to a data buffer.

Parameters

[in]	bmp	The bitmap to save.
[out]	buff	The data buffer to which the bitmap will be saved.
[in]	format	The image format in which to save the bitmap.

Returns: An error code indicating the success or failure of the operation.

◆ saveImage()

int gem::Debug::saveImage	(	const Image &	img,
		DataBuffer &	buff ) const

inlinenoexcept

Get the image internal data from an image object.

Parameters

[in]	img	The image
[out]	buff	The data buffer to which the image internal data is saved

Returns: The image type as EImageFileFormat value if success, otherwise the error code

◆ saveStyle()

int gem::Debug::saveStyle	(	const String &	jsonPath,
		const String &	name,
		const String &	nameRef,
		const DataBuffer &	previewJpg,
		const Size &	szPreview,
		int	majorVer,
		int	minorVer,
		bool	highRes,
		const ParameterList &	params,
		bool	publish ) const

inlinenoexcept

Save a style definition to a JSON path.

Parameters

[in]	jsonPath	The JSON file path where the style definition is stored.
[in]	name	The name of the style to save.
[in]	nameRef	A reference name for the style.
[in]	previewJpg	A data buffer containing a JPEG preview of the style.
[in]	szPreview	The size of the preview image.
[in]	majorVer	The major version number of the style.
[in]	minorVer	The minor version number of the style.
[in]	highRes	A flag indicating whether the style is high resolution.
[in]	params	Additional parameters related to the style.
[in]	publish	A flag indicating whether to publish the style.

Returns: An error code indicating the success or failure of the operation.

◆ sendTopicNotification()

int gem::Debug::sendTopicNotification	(	const String &	topic,
		const String &	message,
		bool	sendByHTTPService ) const

inlinenoexcept

Send a notification message on a specific topic.

Parameters

[in]	topic	The topic on which the message will be sent.
[in]	message	The message to send.
[in]	sendByHTTPService	A boolean flag indicating whether to send the message via HTTP service or directly via MQTT service.

Returns: An error code indicating the success or failure of the operation.

◆ setCustomUrl()

void gem::Debug::setCustomUrl	(	int	svc,
		const String *	url ) const

inlinenoexcept

Set a custom URL for the specified service.

Parameters

[in]	svc	Service identifier for which the URL is to be set.
[in]	url	The URL to set for the service.

◆ setNavigationModifiers()

void gem::Debug::setNavigationModifiers ( int modifiers ) const

inlinenoexcept

Set modifiers for navigation locations.

Parameters

[in] modifiers Bitwise OR of navigation location modifiers.

◆ setRouteName()

void gem::Debug::setRouteName ( const String & name ) const

inlinenoexcept

Set a name for a route for debugging purposes.

Parameters

[in] name The name to assign to the route.

◆ setRoutingAlgoModifiers()

void gem::Debug::setRoutingAlgoModifiers ( int modifiers ) const

inlinenoexcept

Set modifiers for the routing algorithm to alter its behavior.

Parameters

[in] modifiers Bitwise OR of routing algorithm modifiers.

◆ setRoutingDebugDumpPath()

String gem::Debug::setRoutingDebugDumpPath ( const String & path ) const

inlinenoexcept

Set the path for dumping routing information.

Parameters

[in] path The path where routing information should be dumped.

Returns: The set path for confirmation.

◆ setSDKProfile()

void gem::Debug::setSDKProfile	(	int	options,
		ProfileListener	listener = ProfileListener() )

inlinenoexcept

Enable SDK profile options.

Parameters

[in]	options	Bitmask of options to enable for the SDK profile.
[in]	listener	Optional listener to receive profile notifications.

◆ simulateOnSdkActivationAboutToExpire()

void gem::Debug::simulateOnSdkActivationAboutToExpire	(	gem::ESdkActivationAboutToExpireReason	reason,
		gem::LargeInteger	remainingTimeInSeconds ) const

inlinenoexcept

Simulate SDK activation about to expire notification.

Parameters

[in]	reason	The reason for the SDK activation about to expire.
[in]	remainingTimeInSeconds	The remaining time in seconds until the SDK activation expires.

◆ startSimulationPresentation()

int gem::Debug::startSimulationPresentation	(	ERouteTransportMode	transport,
		const Coordinates &	start,
		const Coordinates &	end,
		MapView &	view,
		ProgressListener	listener,
		const Animation &	animation = Animation() )

inlinenoexcept

Start a simulation presentation by calculating a predefined route, starting a simulation, and setting progress to 50%.

Parameters

[in]	transport	The transport mode for the simulation.
[in]	start	Coordinates of the starting point.
[in]	end	Coordinates of the ending point.
[in]	view	The MapView object where the simulation will be presented.
[in]	listener	A listener to handle operation progress.
[in]	animation	Optional animation settings for the simulation.

Returns: An error code indicating the success or failure of the operation.

◆ stopSimulationPresentation()

int gem::Debug::stopSimulationPresentation ( )

inlinenoexcept

Stop the current simulation presentation.

Returns: An error code indicating the success or failure of the operation.

◆ testRerouting()

Route gem::Debug::testRerouting	(	const Coordinates &	dep,
		ETestRerouteStartDirection	dir ) const

inlinenoexcept

Test rerouting from the given coordinates on the closest route.

Parameters

[in]	dep	Coordinates of the departure point.
[in]	dir	Direction for rerouting as defined by ETestRerouteStartDirection.

Returns: A Route object generated during the rerouting test.

◆ testUrl()

int gem::Debug::testUrl	(	const String &	url,
		EHttpMethod	method,
		const DataBuffer &	post,
		ProgressListener	listener ) const

inlinenoexcept

Test a URL with the specified HTTP method and post data.

Parameters

[in]	url	The URL to be tested.
[in]	method	The HTTP method to use for the test (e.g., GET, POST).
[in]	post	The data to be sent in the body of the request for POST method.
[in]	listener	A listener to handle progress updates during the test.

Returns: An error code indicating the success or failure of the URL test.

◆ timeToBetterRouteSec()

int gem::Debug::timeToBetterRouteSec ( ) const

inlinenoexcept

Get the remaining time until the next check for a better route.

Returns: Time in seconds until the next check for a better route.

◆ timeToCheckTrafficAlongRoutesSec()

int gem::Debug::timeToCheckTrafficAlongRoutesSec ( ) const

inlinenoexcept

Get the remaining time until the next check for traffic conditions along all routes.

Returns: Time in seconds until the next traffic check along all routes.

◆ updateMaps()

int gem::Debug::updateMaps ( bool allowPartial = true ) const

inlinenoexcept

Update maps to the latest version synchronously.

Parameters

[in] allowPartial If true, allows partial updates due to space constraints.

Returns: An error code indicating the success or failure of the operation.

Public Member Functions

Detailed Description

Member Function Documentation

◆ breakOnAlloc()

◆ breakOnMaxAlloc()

◆ checkBetterRoute()

◆ checkTrafficAlongRoutes()

◆ corruptContent()

◆ dumpMem()

◆ dumpRoute()

◆ enableRawPositionTracker()

◆ generateAndReloadTrafficAndRoutingSettings()

◆ generateGPSLog()

◆ generateUUIDv4()

◆ getAllWeatherConditions()

◆ getAppIconIds()

◆ getAppIOInfo()

◆ getAppStringsList()

◆ getAuthorizationExpireDate()

◆ getDataAcquisitionTransferStats()

◆ getDefUrls()

◆ getDijkstraProgress()

◆ getFreeMemory()

◆ getImageFromBitmap()

◆ getMapViewCurrentZoomRange()

◆ getMapViewMaxZoomRanges()

◆ getMaxUsedMemory()

◆ getNavigationModifiers()

◆ getNavigationStateInfo()

◆ getResourceUpdaterTransferStats()

◆ getRouteConnections()

◆ getRoutingAlgoModifiers()

◆ getRoutingDebugDumpPaths()

◆ GetSDKProfile()

◆ getServiceName()

◆ getServicesIds()

◆ getSocialLabelsAppVariant()

◆ getStatisticsTransferStats()

◆ getStyleBuilderUrls()

◆ getTotalMemory()

◆ getUsedMemory()

◆ importSiblingBookmarks()

◆ isMainThread()

◆ isOfflineFunctionalityAllowed()

◆ isRawPositionTrackerEnabled()

◆ isValidUUIDv4()

◆ log() [1/2]

◆ log() [2/2]

◆ manyToManyPedestrianCalculation()

◆ oneToOnePedestrianCalculation()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rejectStyle()

◆ replayStreamActivityLog()

◆ reshapeTracks()

◆ saveBitmap() [1/2]

◆ saveBitmap() [2/2]

◆ saveImage()

◆ saveStyle()

◆ sendTopicNotification()

◆ setCustomUrl()

◆ setNavigationModifiers()

◆ setRouteName()

◆ setRoutingAlgoModifiers()

◆ setRoutingDebugDumpPath()

◆ setSDKProfile()

◆ simulateOnSdkActivationAboutToExpire()

◆ startSimulationPresentation()

◆ stopSimulationPresentation()

◆ testRerouting()

◆ testUrl()

◆ timeToBetterRouteSec()

◆ timeToCheckTrafficAlongRoutesSec()

◆ updateMaps()