Loading...
Searching...
No Matches
Zone Class Referenceabstract

Class is used for storing location polygonal zones. More...

Inherits Finalizable.

Public Member Functions

bool isValid ()
 

Public Attributes

Polygon get polygon
 zone's list of points composing the polygonal zone Polygon
 
int get locationId
 zone's location identifier.
 
int get sublocationId
 zone's sublocationId identifier.
 
int get id
 zone's identifier.
 
int get guid
 Optional stable zone GUID used by live tracking (MQTT zone_guids). Distinct from id; may be missing in older location archives.
 
String get name
 zone's name.
 
Color get color
 zone's color.
 
String get alias
 zone's alias.
 

Detailed Description

Class is used for storing location polygonal zones.

Referenced from Sublocation.

Definition at line 25 of file zone.dart.

Member Function Documentation

◆ isValid()

bool Zone.isValid ( )

Member Data Documentation

◆ alias

String get Zone.alias

zone's alias.

Dart code snippet:

// Get zone alias
String? alias = zone.getAlias();
print('Zone alias: $alias');

Definition at line 118 of file zone.dart.

◆ color

Color get Zone.color

zone's color.

Dart code snippet:

// Get zone color
Color color = zone.getColor();
print('Zone color: $color');

Definition at line 107 of file zone.dart.

◆ guid

int get Zone.guid

Optional stable zone GUID used by live tracking (MQTT zone_guids). Distinct from id; may be missing in older location archives.

Dart code snippet:

int? zoneGuid = zone.getGuid();
if (zoneGuid != null) {
print('Zone GUID: $zoneGuid');
}

Definition at line 85 of file zone.dart.

◆ id

int get Zone.id

zone's identifier.

Dart code snippet:

// Get zone ID
int zoneId = zone.getId();
print('Zone ID: $zoneId');

Definition at line 73 of file zone.dart.

◆ locationId

int get Zone.locationId

zone's location identifier.

Dart code snippet:

// Get zone location ID
int locationId = zone.getLocationId();
print('Zone location ID: $locationId');

Definition at line 51 of file zone.dart.

◆ name

String get Zone.name

zone's name.

Dart code snippet:

// Get zone name
String? zoneName = zone.getName();
print('Zone name: $zoneName');

Definition at line 96 of file zone.dart.

◆ polygon

Polygon get Zone.polygon

zone's list of points composing the polygonal zone Polygon

Dart code snippet:

// Get zone polygon
List<Point> polygon = zone.getPolygon();
print('Zone polygon points: ${polygon.length}');

Definition at line 40 of file zone.dart.

◆ sublocationId

int get Zone.sublocationId

zone's sublocationId identifier.

Dart code snippet:

// Get zone sublocation ID
int sublocationId = zone.getSublocationId();
print('Zone sublocation ID: $sublocationId');

Definition at line 62 of file zone.dart.


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