TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase Interface Reference

Use for geofencing rule management. Rules determine the conditions for event generation and the format of these events. More...

Inheritance diagram for TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase:

Public Member Functions
void	AddRule (GeoFenceRuleDef fenceRule)
	Add or replace a rule. All rules contain an identifier, adding a rule with existing identifier already in the service will replace that rule.
List< GeoFenceRuleDef >	GetRules ()
	Get all rules.
List< GeoFenceRuleDef >	GetRulesFromIds (List< Guid > ids)
	Get specific, identified rules.
List< Guid >	GetRuleIds ()
	Get all rule identifiers.
int	DeleteRules (List< Guid > ids)
	Delete identified rules.
void	ClearRules ()
	Delete all rules in the service.
void	SetRangeObject (MovingRangeDef rangeObject)
	Add moving range object. A range object is connected to a track. Each track can have multiple range objects. The center position of a range object is the same as the track position. Note that range objects are treated as geoshapes with respect to conditions.
void	DeleteRangeObject (Guid objectId)
	Delete range object.
MovingRangeDef[]	GetRangeObjects ()
	Get all range objects.

Detailed Description

Use for geofencing rule management. Rules determine the conditions for event generation and the format of these events.

Member Function Documentation

AddRule()

void TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.AddRule

(

GeoFenceRuleDef

fenceRule

)

Add or replace a rule. All rules contain an identifier, adding a rule with existing identifier already in the service will replace that rule.

Parameters

fenceRule

Rule definition

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

ClearRules()

void TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.ClearRules

(

)

Delete all rules in the service.

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

DeleteRangeObject()

void TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.DeleteRangeObject

(

Guid

objectId

)

Delete range object.

Parameters

objectId

Id of object to remove

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

DeleteRules()

int TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.DeleteRules

(

List< Guid >

ids

)

Delete identified rules.

Parameters

ids	Ids of rules to delete

Returns

Number of rules deleted

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

GetRangeObjects()

MovingRangeDef[] TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.GetRangeObjects

(

)

Get all range objects.

Returns

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient.

GetRuleIds()

List< Guid > TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.GetRuleIds

(

)

Get all rule identifiers.

Returns

List contining identifiers of the rules in the service

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

GetRules()

List< GeoFenceRuleDef > TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.GetRules

(

)

Get all rules.

Returns

List contining definitions of the rules in the service

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

GetRulesFromIds()

List< GeoFenceRuleDef > TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.GetRulesFromIds

(

List< Guid >

ids

)

Get specific, identified rules.

Parameters

ids	Identity of the rules to get

Returns

List containing any rules matching identifiers in "ids"

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient, and TPG.GeoFramework.GeoFencingService.GeoFencingService.

SetRangeObject()

void TPG.GeoFramework.GeoFencingServiceInterfaces.IGeoFencingRuleServiceBase.SetRangeObject

(

MovingRangeDef

rangeObject

)

Add moving range object. A range object is connected to a track. Each track can have multiple range objects. The center position of a range object is the same as the track position. Note that range objects are treated as geoshapes with respect to conditions.

Parameters

rangeObject

Range object to add

Implemented in TPG.GeoFramework.GeoFencingClient.FenceRuleServiceClient.

---

The documentation for this interface was generated from the following file:

• Src/Layers/GeoFencing/TPG.GeoFramework.GeoFencingServiceInterfaces/IFenceRuleService.cs