Location class abstract
@ingroup navigine_dart_classes @ingroup navigine_dart_location_elements @brief Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc.
Location instance can be obtained from @see LocationManager "LocationManager" using @see LocationListener "LocationListener" callback, when the location is loaded.
Referenced from @see LocationManager "LocationManager" @see LocationListener "LocationListener".
- Implemented types
- Implementers
Constructors
- Location()
Properties
-
categories
→ List<
Category> -
@brief List of venue categories defined for the location @see Category "Category".
no setter
- descript → String
-
@brief location's description.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → int
-
@brief location's identifier.
no setter
- modified → bool
-
@brief Flag indicates if location has been modified by user or not
no setter
- name → String
-
@brief location name.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sublocations
→ List<
Sublocation> -
@brief List of sublocations @see Sublocation "Sublocation"
no setter
- version → int
-
@brief location's version.
no setter
Methods
-
getCategoryById(
int id) → Category? - @brief Method is used for obtaining a category with the specified identifier from the current location. @param id category identifier. @return @see Category "Category" of the current location with the specified identifier, if it exists. If category with the specified identifier doesn't exist, function returns null.
-
getElevationGraph(
String tag) → ElevationGraph -
@brief Method returns location elevation graph @see ElevationGraph "ElevationGraph"
for specified tag
@param tag Graph tag in CMS
@return Elevation graph instance or
null. @return @see ElevationGraph "ElevationGraph" of the current location with the specified tag, if it exists. If elevation graph with the specified tag doesn't exist, function returns null. -
getGraphTags(
) → List< String> - @brief Method returns list of available graph tags. @return Array of existing tags
-
getSublocationById(
int id) → Sublocation - @brief Method is used for obtaining a sublocation with the specified identifier from the current location. @param id sublocation identifier. @return The @see Sublocation "Sublocation" of the current location with the specified identifier, if it exists. If sublocation with the specified identifier doesn't exist, function returns null.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited