es.situm.sdk.model.location

Class CartesianCoordinate

java.lang.Object

es.situm.sdk.model.location.CartesianCoordinate

All Implemented Interfaces:

android.os.Parcelable

public class CartesianCoordinate
extends Object
implements android.os.Parcelable

A structure that contains cartesian coordinate. Instances are immutable.

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

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<CartesianCoordinate>	CREATOR
static CartesianCoordinate	EMPTY

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

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(Object o)
double	getX() Returns value of coordinate at x-axis
double	getY() Returns value of coordinate at y-axis
int	hashCode()
String	toString()
void	writeToParcel(android.os.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 android.os.Parcelable.Creator<CartesianCoordinate> 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 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:

IllegalArgumentException - if cartesianCoordinate is null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable