Sublocation Class Reference

Class is used for storing sublocation parameters: identifier, name, width, heigth, etc. More...

Inherits Finalizable.

Public Member Functions
LocationPoint	globalToLocal (GlobalPoint globalPoint)
GlobalPoint	localToGlobal (LocationPoint localPoint)
	Method is used for converting the local sublocation coordinates to the global geographic coordinates (latitude and longitude) using the geographic binding of the sublocation.
Graph	getGraph (String tag)
	Method is used to obtain graph (within the current sublocation) with the specified identifier or null if no such graph.
Venue	getVenueById (int id)
	Method returns the venue (within the current sublocation) with the specified identifier or null if no such venue exists.
Zone	getZoneById (int id)
	Method returns the zone (within the current sublocation) with the specified identifier or null if no such zone exists.

Public Attributes
int get	id
	sublocation's identifier.
int get	location
	location's identifier to which the sublocation belongs.
String get	name
	sublocation's name.
double get	width
	sublocation's width in meters.
double get	height
	sublocation's height in meters.
double get	altitude
	sublocation's altitude in meters if specified.
double get	azimuth
	sublocation's azimuth in degrees clockwise.
GlobalPoint get	originPoint
	sublocation's center point in WGS84 coordinates GlobalPoint.
String get	levelId
	sublocation's levelId.
String get	externalId
	sublocation's externalId.
List< Beacon > get	beacons
	List of beacons, attached to this sublocation Beacon.
List< Eddystone > get	eddystones
	List of eddystones, attached to this sublocation Eddystone.
List< Wifi > get	wifis
	List of wifis, attached to this sublocation Wifi.
List< Venue > get	venues
	List of venues, attached to this sublocation Venue.
List< Zone > get	zones
	List of zones, attached to this sublocation Zone.

Detailed Description

Class is used for storing sublocation parameters: identifier, name, width, heigth, etc.

The list of sublocations for the current location can be obtained from Location class using public method getSublocations.

Referenced from Location.

Definition at line 30 of file sublocation.dart.

Member Function Documentation

getGraph()

Graph Sublocation.getGraph

(

String

tag

)

Method is used to obtain graph (within the current sublocation) with the specified identifier or null if no such graph.

Parameters

tag	graph tag.

Returns

found graph or null Graph.

getVenueById()

Venue Sublocation.getVenueById

(

int

id

)

Method returns the venue (within the current sublocation) with the specified identifier or null if no such venue exists.

Parameters

id	venue unique identifier.

Returns

found venue object or null Venue.

getZoneById()

Zone Sublocation.getZoneById

(

int

id

)

Method returns the zone (within the current sublocation) with the specified identifier or null if no such zone exists.

Parameters

id	zone unique identifier.

Returns

found zone object or null Zone.

globalToLocal()

LocationPoint Sublocation.globalToLocal

(

GlobalPoint

globalPoint

)

Method is used for converting the global geographic coordinates (latitude and longitude) to the local sublocation coordinates (x and y) using the geographic binding of the sublocation

Parameters

globalPoint

point in WGS84 coordinates GlobalPoint

Returns

point in metrics coordinates LocationPoint.

localToGlobal()

GlobalPoint Sublocation.localToGlobal

(

LocationPoint

localPoint

)

Method is used for converting the local sublocation coordinates to the global geographic coordinates (latitude and longitude) using the geographic binding of the sublocation.

Parameters

localPoint

point in metrics coordinates LocationPoint

Returns

point in WGS84 coordinates GlobalPoint.

Member Data Documentation

altitude

double get Sublocation.altitude

sublocation's altitude in meters if specified.

Definition at line 102 of file sublocation.dart.

azimuth

double get Sublocation.azimuth

sublocation's azimuth in degrees clockwise.

Definition at line 106 of file sublocation.dart.

beacons

List<Beacon> get Sublocation.beacons

List of beacons, attached to this sublocation Beacon.

Definition at line 122 of file sublocation.dart.

eddystones

List<Eddystone> get Sublocation.eddystones

List of eddystones, attached to this sublocation Eddystone.

Definition at line 126 of file sublocation.dart.

externalId

String get Sublocation.externalId

sublocation's externalId.

Definition at line 118 of file sublocation.dart.

height

double get Sublocation.height

sublocation's height in meters.

Definition at line 98 of file sublocation.dart.

id

int get Sublocation.id

sublocation's identifier.

Definition at line 82 of file sublocation.dart.

levelId

String get Sublocation.levelId

sublocation's levelId.

Definition at line 114 of file sublocation.dart.

location

int get Sublocation.location

location's identifier to which the sublocation belongs.

Definition at line 86 of file sublocation.dart.

name

String get Sublocation.name

sublocation's name.

Definition at line 90 of file sublocation.dart.

originPoint

GlobalPoint get Sublocation.originPoint

sublocation's center point in WGS84 coordinates GlobalPoint.

Definition at line 110 of file sublocation.dart.

venues

List<Venue> get Sublocation.venues

List of venues, attached to this sublocation Venue.

Definition at line 139 of file sublocation.dart.

width

double get Sublocation.width

sublocation's width in meters.

Definition at line 94 of file sublocation.dart.

wifis

List<Wifi> get Sublocation.wifis

List of wifis, attached to this sublocation Wifi.

Definition at line 130 of file sublocation.dart.

zones

List<Zone> get Sublocation.zones

List of zones, attached to this sublocation Zone.

Definition at line 143 of file sublocation.dart.

---

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

• sublocation.dart