Inheritance diagram for gem::AlarmService:

Collaboration diagram for gem::AlarmService:

Public Member Functions
AlarmService &	setAlarmListener (AlarmListener listener) noexcept
	Sets the alarm listener.
AlarmService &	monitorArea (const GeographicArea &area, const String &areaId=String()) noexcept
	Add new geographic area to monitor.
AlarmService &	unmonitorArea (const GeographicArea &area) noexcept
	Remove the given geographic area from monitor.
AlarmService &	unmonitorAreas (const StringList &areaIds) noexcept
	Remove the given geographic area id from monitor.
AlarmService &	unmonitorAllAreas () noexcept
	Remove the all geographic areas from monitor.
AlarmMonitoredAreaList	getMonitoredAreas () noexcept
	Get all monitored areas.
AlarmService &	setAlarmDistance (double distance) noexcept
	Sets the alarm distance in meters.
double	getAlarmDistance () const noexcept
	Gets the distance in meters for alarming.
LandmarkStoreCollectionRef	lmks () noexcept
	Gets access to the alarm settings for the landmark stores.
OverlayMutableCollectionRef	overlays () noexcept
	Gets access to the collection of overlays to use for alarm.
AlarmService &	setMonitorWithoutRoute (bool value) noexcept
	Select if alarms should be provided when navigating without route.
bool	getMonitorWithoutRoute () const noexcept
	Gets the status of the "alarming without route" flag.
AlarmService &	setOverSpeedThreshold (double threshold, bool insideCityArea) noexcept
	Set the alarm overspeed threshold value, in meters per second.
double	getOverSpeedThreshold (bool insideCityArea) const noexcept
	Get the alarm overspeed threshold value, in meters per second.
sense::PositionPtr	getReferencePosition () const noexcept
	Gets alarm current reference position.
const GeographicAreaListRef	getCrossedBoundaries () const noexcept
	Gets alarm current boundary crossed.
AlarmMonitoredAreaListRef	getInsideAreas () const noexcept
	Gets area list containing current referenced position.
AlarmMonitoredAreaListRef	getOutsideAreas () const noexcept
	Gets area list not containing current referenced position.
const LandmarkAlarmsListRef	getLandmarkAlarms () const noexcept
	Provides the list of active landmark alarms.
const OverlayItemAlarmsListRef	getOverlayItemAlarms () const noexcept
	Provides the list of active overlay item alarms.
const LandmarkAlarmsListRef	getLandmarkAlarmsPassedOver () const noexcept
	Provides the list of passed over landmark alarms.
const OverlayItemAlarmsListRef	getOverlayItemAlarmsPassedOver () const noexcept
	Provides the list of passed over overlay item alarms.
int	setTrackedPositionSource (sense::DataSourcePtr positionSource) noexcept
	Sets the tracking position source.
sense::DataSourcePtr	getTrackedPositionSource () const noexcept
	Gets the tracking position source.

Static Public Member Functions
static StrongPointer< AlarmService >	produce (AlarmListener listener)
	create an AlarmService object

Detailed Description

AlarmService object.

Implements share-read / write Api object over IAlarmService.

Manages alarms and timed notifications in the SDK.

Allows applications to schedule, trigger, and cancel alarms that can be tied to navigation or sensor-driven events.

Member Function Documentation

◆ getAlarmDistance()

double gem::AlarmService::getAlarmDistance ( ) const

inlinenoexcept

Gets the distance in meters for alarming.

Returns: Distance in meters.

◆ getCrossedBoundaries()

const GeographicAreaListRef gem::AlarmService::getCrossedBoundaries ( ) const

inlinenoexcept

Gets alarm current boundary crossed.

Deprecated

The function will always return empty GeographicAreaListRef

Use getInsideAreas and getOutsideAreas in order to get areas containing the location reference and areas not containing the location reference.

The API client can check if the current position enters or exits a geographic area using GeographicArea::containsCoordinates.

Returns: The list of crossed boundaries.

◆ getInsideAreas()

AlarmMonitoredAreaListRef gem::AlarmService::getInsideAreas ( ) const

inlinenoexcept

Gets area list containing current referenced position.

Returns: The list of areas containing current referenced position

◆ getLandmarkAlarms()

const LandmarkAlarmsListRef gem::AlarmService::getLandmarkAlarms ( ) const

inlinenoexcept

Provides the list of active landmark alarms.

When all alarms become inactive the list of landmark alarms is empty(const LandmarkAlarmsListRef.size() == 0).

Returns: The list of active landmark alarms.

◆ getLandmarkAlarmsPassedOver()

const LandmarkAlarmsListRef gem::AlarmService::getLandmarkAlarmsPassedOver ( ) const

inlinenoexcept

Provides the list of passed over landmark alarms.

Returns: The list of passed over landmark alarms.

◆ getMonitoredAreas()

AlarmMonitoredAreaList gem::AlarmService::getMonitoredAreas ( )

inlinenoexcept

Get all monitored areas.

Returns: The monitored areas list

◆ getMonitorWithoutRoute()

bool gem::AlarmService::getMonitorWithoutRoute ( ) const

inlinenoexcept

Gets the status of the "alarming without route" flag.

Returns: True if monitoring without route is enabled, false otherwise.

◆ getOutsideAreas()

AlarmMonitoredAreaListRef gem::AlarmService::getOutsideAreas ( ) const

inlinenoexcept

Gets area list not containing current referenced position.

Returns: The list of areas not containing current referenced position

◆ getOverlayItemAlarms()

const OverlayItemAlarmsListRef gem::AlarmService::getOverlayItemAlarms ( ) const

inlinenoexcept

Provides the list of active overlay item alarms.

When all alarms become inactive the list of overlay item alarms is empty(const OverlayItemAlarmsListRef.size() == 0).

Returns: The list of active overlay item alarms.

◆ getOverlayItemAlarmsPassedOver()

const OverlayItemAlarmsListRef gem::AlarmService::getOverlayItemAlarmsPassedOver ( ) const

inlinenoexcept

Provides the list of passed over overlay item alarms.

Returns: The list of passed over overlay item alarms.

◆ getOverSpeedThreshold()

double gem::AlarmService::getOverSpeedThreshold ( bool insideCityArea ) const

inlinenoexcept

Get the alarm overspeed threshold value, in meters per second.

Parameters

insideCityArea Specify whether the returned threshold is for inside city area or for outside city area.

Returns: The overspeed threshold value in meters per second.

◆ getReferencePosition()

sense::PositionPtr gem::AlarmService::getReferencePosition ( ) const

inlinenoexcept

Gets alarm current reference position.

Returns: The reference position.

◆ getTrackedPositionSource()

sense::DataSourcePtr gem::AlarmService::getTrackedPositionSource ( ) const

inlinenoexcept

Gets the tracking position source.

Returns: The tracked position source. By default the tracked position source is the current set in PositionService

◆ lmks()

LandmarkStoreCollectionRef gem::AlarmService::lmks ( )

inlinenoexcept

Gets access to the alarm settings for the landmark stores.

Returns: Ref to collection of landmark stores.

◆ monitorArea()

AlarmService & gem::AlarmService::monitorArea	(	const GeographicArea &	area,
		const String &	areaId = String() )

inlinenoexcept

Add new geographic area to monitor.

Parameters

area	Area to be monitored.
areaId	The id of the area.

Returns: reference to the AlarmService object

◆ overlays()

OverlayMutableCollectionRef gem::AlarmService::overlays ( )

inlinenoexcept

Gets access to the collection of overlays to use for alarm.

Returns: Ref to collection of overlays

◆ produce()

StrongPointer< AlarmService > gem::AlarmService::produce ( AlarmListener listener )

inlinestatic

create an AlarmService object

Parameters

listener Alarm listener that will get all the alarm service related notifications.

Returns: Strong pointer containing the alarm service.

◆ setAlarmDistance()

AlarmService & gem::AlarmService::setAlarmDistance ( double distance )

inlinenoexcept

Sets the alarm distance in meters.

Parameters

distance Distance in meters.

Returns: reference to the AlarmService object

◆ setAlarmListener()

AlarmService & gem::AlarmService::setAlarmListener ( AlarmListener listener )

inlinenoexcept

Sets the alarm listener.

Parameters

listener Alarm listener.

If the listener is empty then the alarm service will stop sending notifications.

Returns: reference to the AlarmService object

◆ setMonitorWithoutRoute()

AlarmService & gem::AlarmService::setMonitorWithoutRoute ( bool value )

inlinenoexcept

Select if alarms should be provided when navigating without route.

Parameters

value Enable or disable monitoring without route.

Returns: reference to the AlarmService object

◆ setOverSpeedThreshold()

AlarmService & gem::AlarmService::setOverSpeedThreshold	(	double	threshold,
		bool	insideCityArea )

inlinenoexcept

Set the alarm overspeed threshold value, in meters per second.

Parameters

threshold	Value in meters per second.
insideCityArea	Specify whether the given threshold is for inside city area or for outside city area.

Returns: reference to the AlarmService object

◆ setTrackedPositionSource()

int gem::AlarmService::setTrackedPositionSource ( sense::DataSourcePtr positionSource )

inlinenoexcept

Sets the tracking position source.

Parameters

[in] positionSource The position source to be tracked. By default the tracked position source is the current set in PositionService

Returns: KNoError Success.

◆ unmonitorAllAreas()

AlarmService & gem::AlarmService::unmonitorAllAreas ( )

inlinenoexcept

Remove the all geographic areas from monitor.

Returns: reference to the AlarmService object

◆ unmonitorArea()

AlarmService & gem::AlarmService::unmonitorArea ( const GeographicArea & area )

inlinenoexcept

Remove the given geographic area from monitor.

Parameters

area	Area to be unmonitored.

Returns: reference to the AlarmService object

◆ unmonitorAreas()

AlarmService & gem::AlarmService::unmonitorAreas ( const StringList & areaIds )

inlinenoexcept

Remove the given geographic area id from monitor.

Parameters

areaIds Area ids to be unmonitored.

Returns: reference to the AlarmService object

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getAlarmDistance()

◆ getCrossedBoundaries()

◆ getInsideAreas()

◆ getLandmarkAlarms()

◆ getLandmarkAlarmsPassedOver()

◆ getMonitoredAreas()

◆ getMonitorWithoutRoute()

◆ getOutsideAreas()

◆ getOverlayItemAlarms()

◆ getOverlayItemAlarmsPassedOver()

◆ getOverSpeedThreshold()

◆ getReferencePosition()

◆ getTrackedPositionSource()

◆ lmks()

◆ monitorArea()

◆ overlays()

◆ produce()

◆ setAlarmDistance()

◆ setAlarmListener()

◆ setMonitorWithoutRoute()

◆ setOverSpeedThreshold()

◆ setTrackedPositionSource()

◆ unmonitorAllAreas()

◆ unmonitorArea()

◆ unmonitorAreas()