com.ur.urcap.api.domain.value

Interface Position

public interface Position

This interface represents a Cartesian position

Method Summary

Modifier and Type	Method and Description
boolean	epsilonEquals(Position other, double epsilon, Length.Unit unit) Indicates whether some other Position object is "approximately equal" to this one.
boolean	equals(Object obj) Indicates whether some other Position object is "equal to" this one.
double	getX() Deprecated. Use getX(Length.Unit)
double	getX(Length.Unit unit) Provides the X coordinate value in specified units
double	getY() Deprecated. Use getY(Length.Unit)
double	getY(Length.Unit unit) Provides the Y coordinate value in specified units
double	getZ() Deprecated. Use getZ(Length.Unit)
double	getZ(Length.Unit unit) Provides the Z coordinate value in specified units
int	hashCode()
String	toString()

Method Detail

getX

double getX()

Deprecated. Use getX(Length.Unit)

Returns:

X coordinate value in meters

getY

double getY()

Deprecated. Use getY(Length.Unit)

Returns:

Y coordinate value in meters

getZ

double getZ()

Deprecated. Use getZ(Length.Unit)

Returns:

Z coordinate value in meters

getX

double getX(Length.Unit unit)

Provides the X coordinate value in specified units

Parameters:

unit - the unit type

Returns:

double value in specified units

getY

double getY(Length.Unit unit)

Provides the Y coordinate value in specified units

Parameters:

unit - the unit type

Returns:

double value in specified units

getZ

double getZ(Length.Unit unit)

Provides the Z coordinate value in specified units

Parameters:

unit - the unit type

Returns:

double value in specified units

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

equals

boolean equals(Object obj)

Indicates whether some other Position object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - another Position object

Returns:

equals if the value of this Position and the obj argument are exactly the same.

epsilonEquals

boolean epsilonEquals(Position other,
                      double epsilon,
                      Length.Unit unit)

Indicates whether some other Position object is "approximately equal" to this one.

Parameters:

other - another Position object

epsilon - a tolerance

unit - the unit type of the epsilon tolerance

Returns:

true if the value of this object is "approximately equal" to the value of the other argument; false otherwise.

toString

String toString()

Overrides:

toString in class Object

Returns:

a string representation of the position