com.navigine.idl.java.Zone Class Reference

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

Inheritance diagram for com.navigine.idl.java.Zone:

Public Member Functions
abstract Polygon	getPolygon ()
	zone's list of points composing the polygonal zone Polygon
abstract int	getLocationId ()
	zone's location identifier.
abstract int	getSublocationId ()
	zone's sublocationId identifier.
abstract int	getId ()
	zone's identifier.
abstract String	getName ()
	zone's name.
abstract String	getColor ()
	zone's color.
abstract String	getAlias ()
	zone's alias.
abstract boolean	isValid ()

Detailed Description

Class is used for storing location polygonal zones.

Referenced from Sublocation.

Definition at line 15 of file Zone.java.

Member Function Documentation

getAlias()

abstract String com.navigine.idl.java.Zone.getAlias ( )

abstract

zone's alias.

Returns

Java code snippet:

        // Get zone alias
        String alias = zone.getAlias();
        System.out.println("Zone alias: " + alias);

Kotlin code snippet:

        // Get zone alias
        val alias = zone.alias
        println("Zone alias: $alias")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getColor()

abstract String com.navigine.idl.java.Zone.getColor ( )

abstract

zone's color.

Returns

Java code snippet:

        // Get zone color
        String color = zone.getColor();
        System.out.println("Zone color: " + color);

Kotlin code snippet:

        // Get zone color
        val color = zone.color
        println("Zone color: $color")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getId()

abstract int com.navigine.idl.java.Zone.getId ( )

abstract

zone's identifier.

Returns

Java code snippet:

        // Get zone ID
        int zoneId = zone.getId();
        System.out.println("Zone ID: " + zoneId);

Kotlin code snippet:

        // Get zone ID
        val zoneId = zone.id
        println("Zone ID: $zoneId")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getLocationId()

abstract int com.navigine.idl.java.Zone.getLocationId ( )

abstract

zone's location identifier.

Returns

Java code snippet:

        // Get zone location ID
        int locationId = zone.getLocationId();
        System.out.println("Zone location ID: " + locationId);

Kotlin code snippet:

        // Get zone location ID
        val locationId = zone.locationId
        println("Zone location ID: $locationId")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getName()

abstract String com.navigine.idl.java.Zone.getName ( )

abstract

zone's name.

Returns

Java code snippet:

        // Get zone name
        String zoneName = zone.getName();
        System.out.println("Zone name: " + zoneName);

Kotlin code snippet:

        // Get zone name
        val zoneName = zone.name
        println("Zone name: $zoneName")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getPolygon()

abstract Polygon com.navigine.idl.java.Zone.getPolygon ( )

abstract

zone's list of points composing the polygonal zone Polygon

Returns

Java code snippet:

        // Get zone polygon
        java.util.ArrayList<Point> polygon = zone.getPolygon();
        System.out.println("Zone polygon points: " + polygon.size());

Kotlin code snippet:

        // Get zone polygon
        val polygon = zone.polygon
        println("Zone polygon points: ${polygon.size}")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

getSublocationId()

abstract int com.navigine.idl.java.Zone.getSublocationId ( )

abstract

zone's sublocationId identifier.

Returns

Java code snippet:

        // Get zone sublocation ID
        int sublocationId = zone.getSublocationId();
        System.out.println("Zone sublocation ID: " + sublocationId);

Kotlin code snippet:

        // Get zone sublocation ID
        val sublocationId = zone.sublocationId
        println("Zone sublocation ID: $sublocationId")

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

isValid()

abstract boolean com.navigine.idl.java.Zone.isValid ( )

abstract

Tells if this Zone is valid or not. Any other method (except for this one) called on an invalid Zone will throw java.lang.RuntimeException.

Reimplemented in com.navigine.idl.java.internal.ZoneBinding.

---

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

• Zone.java