es.situm.sdk.model.location

Class CartesianCoordinate

java.lang.Object

es.situm.sdk.model.location.CartesianCoordinate

public class CartesianCoordinate
extends java.lang.Object

A structure that contains cartesian coordinate. Instances are immutable.

See CoordinateConverter to convert between Coordinate and CartesianCoordinate's building coordinate.

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR
static CartesianCoordinate	EMPTY

Constructor Summary

Constructors

Constructor and Description
CartesianCoordinate(CartesianCoordinate copy)
CartesianCoordinate(double x, double y)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
double	distanceTo(CartesianCoordinate cartesianCoordinate) Calculates the distance (in meters) between this cartesian coordinate and another
boolean	equals(java.lang.Object o)
double	getX() Returns value of coordinate at x-axis
double	getY() Returns value of coordinate at y-axis
int	hashCode()
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

public static final CartesianCoordinate EMPTY

CREATOR

public static final <any> CREATOR

Constructor Detail

CartesianCoordinate

public CartesianCoordinate(double x,
                           double y)

CartesianCoordinate

public CartesianCoordinate(CartesianCoordinate copy)

Method Detail

getX

public double getX()

Returns value of coordinate at x-axis

Returns:

double. Default is 0

getY

public double getY()

Returns value of coordinate at y-axis

Returns:

double. Default is 0

distanceTo

public double distanceTo(CartesianCoordinate cartesianCoordinate)
                  throws java.lang.IllegalArgumentException

Calculates the distance (in meters) between this cartesian coordinate and another

Parameters:

cartesianCoordinate - the other cartesian coordinate. Can't be null

Returns:

distance in meters. Never a negative value

Throws:

java.lang.IllegalArgumentException - if cartesianCoordinate is null

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)