es.situm.sdk.model.cartography

Class Point

java.lang.Object

es.situm.sdk.model.cartography.Point

All Implemented Interfaces:

BuildingResource, FloorResource

public class Point
extends java.lang.Object
implements FloorResource

Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building. Instances are immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR
static Point	EMPTY_INDOOR
static Point	EMPTY_OUTDOOR

Constructor Summary

Constructors

Constructor and Description
Point(Building building, java.lang.String floorIdentifier, CartesianCoordinate cartesianCoordinate) Create a point placed indoors.
Point(Coordinate coordinate) Create a point placed outdoors.
Point(Point point)
Point(java.lang.String buildingIdentifier, Coordinate coordinate) Create a point placed outdoors.
Point(java.lang.String buildingIdentifier, java.lang.String floorIdentifier, Coordinate coordinate, CartesianCoordinate cartesianCoordinate) Create a point placed indoors.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
java.lang.String	getBuildingIdentifier() Returns unique identifier for the building to which this point belongs
CartesianCoordinate	getCartesianCoordinate() Returns cartesian coordinate (in meters) relative to the Bounds of building's base.
Coordinate	getCoordinate() Returns geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building You can obtain this value from CartesianCoordinate using CoordinateConverter.
java.lang.String	getFloorIdentifier() Returns floor identifier (inside the building) where this point is placed.
int	hashCode()
boolean	isIndoor() Return if the POI is inside the building.
boolean	isOutdoor() Return if the POI is outside the building.
boolean	sameFloor(Point that)
java.lang.String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_INDOOR

public static final Point EMPTY_INDOOR

EMPTY_OUTDOOR

public static final Point EMPTY_OUTDOOR

CREATOR

public static final <any> CREATOR

Constructor Detail

Point

public Point(Coordinate coordinate)

Create a point placed outdoors. It has no cartesian coordinate nor floor, because it's placed outside the building.

Parameters:

coordinate -

Point

public Point(java.lang.String buildingIdentifier,
             Coordinate coordinate)

Create a point placed outdoors. It has no cartesian coordinate nor floor, because it's placed outside the building.

Parameters:

buildingIdentifier -

coordinate -

Point

public Point(java.lang.String buildingIdentifier,
             java.lang.String floorIdentifier,
             Coordinate coordinate,
             CartesianCoordinate cartesianCoordinate)

Create a point placed indoors.

Parameters:

buildingIdentifier -

floorIdentifier -

coordinate -

cartesianCoordinate -

Point

public Point(Building building,
             java.lang.String floorIdentifier,
             CartesianCoordinate cartesianCoordinate)

Create a point placed indoors. The geographical coordinate is calculated using the building

Point

public Point(Point point)

Method Detail

getCartesianCoordinate

public final CartesianCoordinate getCartesianCoordinate()

Returns cartesian coordinate (in meters) relative to the Bounds of building's base. If this point is outdoors (isOutdoor == true), this field has no meaning.

Returns:

Coordinate of this point, or (0,0) if it's outdoors.

See Also:

#isOutdoor()} to check if the poi is indoors or outdoors

getCoordinate

public final Coordinate getCoordinate()

Returns geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building You can obtain this value from CartesianCoordinate using CoordinateConverter.

Returns:

Coordinate of this point.

getBuildingIdentifier

public final java.lang.String getBuildingIdentifier()

Returns unique identifier for the building to which this point belongs

Specified by:

getBuildingIdentifier in interface BuildingResource

getFloorIdentifier

public final java.lang.String getFloorIdentifier()

Returns floor identifier (inside the building) where this point is placed. If this point is outdoors, this field has no meaning.

Specified by:

getFloorIdentifier in interface FloorResource

Returns:

String. If the point is outdoors, the value is unexpected.

See Also:

#isOutdoor()} to check if the poi is indoors or outdoors

isOutdoor

public final boolean isOutdoor()

Return if the POI is outside the building.

Returns:

true if the building is outdoors. Otherwise, false.

isIndoor

public final boolean isIndoor()

Return if the POI is inside the building.

Returns:

true if the building is indoors. Otherwise, false.

sameFloor

public final boolean sameFloor(Point that)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)