Inheritance diagram for gem::RouteBookmarks:

Collaboration diagram for gem::RouteBookmarks:

Public Member Functions
	RouteBookmarks (RouteBookmarks &&routeBookmark)=default
	Default move constructor noexcept is deduced.
RouteBookmarks &	operator= (RouteBookmarks &&routeBookmark)=default
	Default move assignment noexcept is deduced.
String	getFilePath () const noexcept
	Get Bookmarks collection path.
void	setSortOrder (ERouteBookmarksSortOrder order) noexcept
	Change the sort order of the routes.
int	size () const noexcept
	Get number of routes.
const StringRef	getName (int index) const noexcept
	Get name of the route specified by index.
const RoutePreferencesRef	getPreferences (int index) const noexcept
	Get preferences of the route specified by index.
const LandmarkListRef	getWaypoints (int index) const noexcept
	Get waypoints of the route specified by index.
const TimeRef	getTimestamp (int index) const noexcept
	Get timestamp of the route specified by index.
RouteBookmarks &	update (int index, const String &name=String(), const LandmarkList &waypoints=LandmarkList(), const RoutePreferences &preferences=RoutePreferences()) noexcept
	Update a route.
RouteBookmarks &	add (const String &name, const LandmarkList &waypoints, const RoutePreferences &preferences=RoutePreferences(), bool overwrite=false) noexcept
	Add a new route / update existing.
int	addTrips (const String &filename, bool skipDuplicates=true) noexcept
	Add trips from the given filename.
RouteBookmarks &	remove (int index) noexcept
	Remove the item at the specified index.
int	find (const String &name) noexcept
	Find a trip by name.
void	clear () noexcept
	Clear all routes bookmarks.
int	exportToFile (int index, const String &path) const noexcept
	Export the route to the given file.
template<typename TCollector>
bool	iterateRoutes (TCollector collector) const noexcept
	Iterate all bookmarked routes.
RouteBookmarks &	setAutoDeleteMode (bool mode) noexcept
	Set auto delete mode.
bool	getAutoDeleteMode () const noexcept
	Get auto delete mode.

Static Public Member Functions
static StrongPointer< RouteBookmarks >	produce (const String &name, const String &folder=String())
	Constructor.
static String	getBaseUniqueName (const LandmarkList &lmks)
	Create a basic route unique name based on waypoints coordinates.
static int	setWaypointTrackData (Landmark &lmk, const Path &track) noexcept
	Add the given track to waypoint.
static Path	getWaypointTrackData (const Landmark &lmk) noexcept
	Extract track from the given waypoint.
static bool	waypointHasTrackData (const Landmark &lmk) noexcept
	Check if waypoint has track data.
static int	reverseWaypointTrackData (Landmark &lmk) noexcept
	Reverse waypoint track data.
static int	setWaypointTrackDepartureAndDestination (Landmark &lmk, const Coordinates &dep, const Coordinates &dst) noexcept
	Truncate track data between the given departure and destination coordinates.

Detailed Description

RouteBookmarks object.

Implements share-read / write Api object over IRouteBookmarks.

Constructor & Destructor Documentation

◆ RouteBookmarks()

gem::RouteBookmarks::RouteBookmarks ( RouteBookmarks && routeBookmark )

default

Default move constructor noexcept is deduced.

Parameters

[in] routeBookmark The RouteBookmarks object to be moved.

Member Function Documentation

◆ add()

RouteBookmarks & gem::RouteBookmarks::add	(	const String &	name,
		const LandmarkList &	waypoints,
		const RoutePreferences &	preferences = RoutePreferences(),
		bool	overwrite = false )

inlinenoexcept

Add a new route / update existing.

Parameters

[in]	name	The new route name, must be unique. If a route with this name already exists, error::KExist is returned
[in]	waypoints	Route waypoints list
[in]	preferences	Route preferences
[in]	overwrite	Overwrite route if name already exists

If a route with given name already exists and overwrite = true, the existing route is updated

Only route relevant preferences are saved: transport mode + avoid preferences

Returns: RouteBookmarks object

◆ addTrips()

int gem::RouteBookmarks::addTrips	(	const String &	filename,
		bool	skipDuplicates = true )

inlinenoexcept

Add trips from the given filename.

Parameters

[in]	filename	The imported bookmarks file path
[in]	skipDuplicates	Whether or not to skip duplicates, Default true.

Returns: On success: the number of imported routes, otherwise the operation error

◆ exportToFile()

int gem::RouteBookmarks::exportToFile	(	int	index,
		const String &	path ) const

inlinenoexcept

Export the route to the given file.

Parameters

[in]	index	The route index to be exported
[in]	path	The file path where the route will be exported

Returns: 0 if the route was successfully exported

◆ find()

int gem::RouteBookmarks::find ( const String & name )

inlinenoexcept

Find a trip by name.

Parameters

[in] name The route name

Returns: On success - the route index in current sort order, on failure - the error code

◆ getAutoDeleteMode()

bool gem::RouteBookmarks::getAutoDeleteMode ( ) const

inlinenoexcept

Get auto delete mode.

If auto delete mode is true, the database if automatically deleted when object is destroyed

Default is false

Returns: The auto delete mode

◆ getBaseUniqueName()

String gem::RouteBookmarks::getBaseUniqueName ( const LandmarkList & lmks )

inlinestatic

Create a basic route unique name based on waypoints coordinates.

Parameters

[in] lmks The landmark names

Returns: The base unique name

◆ getFilePath()

String gem::RouteBookmarks::getFilePath ( ) const

inlinenoexcept

Get Bookmarks collection path.

Returns: The path of the bookmarks collection

◆ getName()

const StringRef gem::RouteBookmarks::getName ( int index ) const

inlinenoexcept

Get name of the route specified by index.

Route name is the unique identifier of a route

Parameters

[in] index The index of the route in the current sort order

Returns: The route name

◆ getPreferences()

const RoutePreferencesRef gem::RouteBookmarks::getPreferences ( int index ) const

inlinenoexcept

Get preferences of the route specified by index.

Parameters

[in] index The index of the route in the current sorting

Returns: The route preferences

◆ getTimestamp()

const TimeRef gem::RouteBookmarks::getTimestamp ( int index ) const

inlinenoexcept

Get timestamp of the route specified by index.

Parameters

[in] index The index of the route in the current sort order

Returns: The route timestamp

◆ getWaypoints()

const LandmarkListRef gem::RouteBookmarks::getWaypoints ( int index ) const

inlinenoexcept

Get waypoints of the route specified by index.

Parameters

[in] index The index of the route in the current sort order

Returns: The route waypoints list

◆ getWaypointTrackData()

Path gem::RouteBookmarks::getWaypointTrackData ( const Landmark & lmk )

inlinestaticnoexcept

Extract track from the given waypoint.

Parameters

[in] lmk The landmark waypoint

Returns: The track as a path object

◆ iterateRoutes()

template<typename TCollector>

bool gem::RouteBookmarks::iterateRoutes ( TCollector collector ) const

inlinenoexcept

Iterate all bookmarked routes.

Collector signature should be bool( const String&, const LandmarkList&, const RoutePreferences&, const Time& )

Collector should return true if iteration should continue and false if iteration should stop

Parameters

[in] collector The collector function

Returns: true if all routes were iterated, false if iteration was stopped

◆ operator=()

RouteBookmarks & gem::RouteBookmarks::operator= ( RouteBookmarks && routeBookmark )

default

Default move assignment noexcept is deduced.

Parameters

[in] routeBookmark The RouteBookmarks object to be moved.

Returns: The RouteBookmarks object.

◆ produce()

StrongPointer< RouteBookmarks > gem::RouteBookmarks::produce	(	const String &	name,
		const String &	folder = String() )

inlinestatic

Constructor.

Parameters

[in]	name	Collection name
[in]	folder	Collection folder location. If not provided a default SDK location will be used

Returns: RouteBookmarks StrongPointer(std::shared_ptr) object

◆ remove()

RouteBookmarks & gem::RouteBookmarks::remove ( int index )

inlinenoexcept

Remove the item at the specified index.

Parameters

[in] index The route index to be removed

Returns: RouteBookmarks object

◆ reverseWaypointTrackData()

int gem::RouteBookmarks::reverseWaypointTrackData ( Landmark & lmk )

inlinestaticnoexcept

Reverse waypoint track data.

Parameters

[in,out] lmk The landmark waypoint where track data is reversed

Returns: 0 if the track was successfully reversed

◆ setAutoDeleteMode()

RouteBookmarks & gem::RouteBookmarks::setAutoDeleteMode ( bool mode )

inlinenoexcept

Set auto delete mode.

Parameters

[in] mode The Auto-delete mode

Returns: RouteBookmarks object

◆ setSortOrder()

void gem::RouteBookmarks::setSortOrder ( ERouteBookmarksSortOrder order )

inlinenoexcept

Change the sort order of the routes.

Default order is ESortByDate. UI needs to refresh the list.

Parameters

[in] order The new sort order

◆ setWaypointTrackData()

int gem::RouteBookmarks::setWaypointTrackData	(	Landmark &	lmk,
		const Path &	track )

inlinestaticnoexcept

Add the given track to waypoint.

Parameters

[in,out]	lmk	The landmark waypoint
[in]	track	The track as a path object

Returns: 0 if the track was successfully added

◆ setWaypointTrackDepartureAndDestination()

int gem::RouteBookmarks::setWaypointTrackDepartureAndDestination	(	Landmark &	lmk,
		const Coordinates &	dep,
		const Coordinates &	dst )

inlinestaticnoexcept

Truncate track data between the given departure and destination coordinates.

Set dep = dest to create a track circuit

Parameters

[in,out]	lmk	The landmark waypoint where track data is reversed
[in]	dep	The new track departure coordinate
[in]	dst	The new track destination coordinate

Returns: 0 if the track was successfully truncated ErrorCodes

◆ size()

int gem::RouteBookmarks::size ( ) const

inlinenoexcept

Get number of routes.

Returns: The number of routes in the collection

◆ update()

RouteBookmarks & gem::RouteBookmarks::update	(	int	index,
		const String &	name = String(),
		const LandmarkList &	waypoints = LandmarkList(),
		const RoutePreferences &	preferences = RoutePreferences() )

inlinenoexcept

Update a route.

Parameters

[in]	index	The index of the route in the current sort order
[in]	name	The new route name, must be unique. If a route with this name already exists, error::KExist is returned
[in]	waypoints	Route waypoints list
[in]	preferences	Route preferences

Only route relevant preferences are saved: transport mode + avoid preferences

Returns: RouteBookmarks object

◆ waypointHasTrackData()

bool gem::RouteBookmarks::waypointHasTrackData ( const Landmark & lmk )

inlinestaticnoexcept

Check if waypoint has track data.

Parameters

[in] lmk The landmark waypoint

Returns: Return true if waypoint has track data attached

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RouteBookmarks()

Member Function Documentation

◆ add()

◆ addTrips()

◆ exportToFile()

◆ find()

◆ getAutoDeleteMode()

◆ getBaseUniqueName()

◆ getFilePath()

◆ getName()

◆ getPreferences()

◆ getTimestamp()

◆ getWaypoints()

◆ getWaypointTrackData()

◆ iterateRoutes()

◆ operator=()

◆ produce()

◆ remove()

◆ reverseWaypointTrackData()

◆ setAutoDeleteMode()

◆ setSortOrder()

◆ setWaypointTrackData()

◆ setWaypointTrackDepartureAndDestination()

◆ size()

◆ update()

◆ waypointHasTrackData()