Geo-Fence Context Reference
This context has same actions as model context except additional functions:
Public Variables (Properties)
Properties
This setting defines basic properties of a geo-fence.
Field | Type | Description |
Name | String | Geo-Fence name. |
Description | String | Geo-Fence description. |
Parameters
This setting defines parameters of a geo-fence.
Field | Type | Description |
Type | String | The list of available types: Polygon, Points, Path |
Editable | Boolean | Is Geo-Fence editable |
Points
This table defines geo-fence point coordinates and parameters.
Field | Type | Description |
Latitude | Double | Latitude is a geographic coordinate that specifies the north-south position of a point on the Earth's surface. |
Longitude | Double | Longitude is a geographic coordinate that specifies the east-west position of a point on the Earth's surface. |
Description | String | Point description. |
Public Functions
Rotate
Rotate selected geo-fence.
Function Name: | rotate | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Theta | Double | Angle of rotation. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
success | Boolean | True if rotating was finished successful. Otherwise false. | |
Move
Move selected geo-fence.
Function Name: | move | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
T X | Double | X Offset Value. | |
T Y | Double | Y Offset Value. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
success | Boolean | True if moving was finished successful. Otherwise false. | |
Distance
Returns distance from point to current geo-fence.
Function Name: | distance | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Latitude | Double | Latitude of a point from which to calculate the distance. | |
Longitude | Double | Longitude of a point from which to calculate the distance. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
Distance | Double | Distance to geo-fence. | |
Intersects
Returns true if selected geo-fence intersects with current geo-fence.
Function Name: | intersect | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Geo-fence Context | String | The context of geo-fences that will be checked for intersects. | |
Longitude | Double | Longitude of a point is checked for the including in geofence. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
Intersect | Boolean | Is geo-fences intersecting. | |
Scale
Scale selected geo-fence.
Function Name: | scale | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Scale | Double | Scaling factor. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
success | Boolean | True if scaling was finished successful. Otherwise false. | |
Includes
Returns true if point included into current geo-fence.
Function Name: | includes | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Latitude | Double | Latitude of a point is checked for the including in geofence. | |
Longitude | Double | Longitude of a point is checked for the including in geofence. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
Includes | Boolean | Is geo-fence include point. | |
Flip
Flip selected geo-fence.
Function Name: | flip | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
|---|---|---|---|
Flip X | Boolean | Flip geo-fence horizontally. | |
Flip Y | Boolean | Flip geo-fence vertically. | |
Output Records: | 1 | ||
Output Format: | |||
Name | Type | Description | |
|---|---|---|---|
success | Boolean | True if flipping was finished successful. Otherwise false. | |
Was this page helpful?