com.ur.urcap.api.domain.value

Interface Position

public interface Position

This interface represents a Cartesian position.

Since:

1.0.0

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) instead.
double	getX(Length.Unit unit) Provides the X coordinate value in specified units.
double	getY() Deprecated. Use getY(Length.Unit) instead.
double	getY(Length.Unit unit) Provides the Y coordinate value in specified units.
double	getZ() Deprecated. Use getZ(Length.Unit) instead.
double	getZ(Length.Unit unit) Provides the Z coordinate value in specified units.
int	hashCode()
String	toString()

Method Detail

getX

@Deprecated
double getX()

Deprecated. Use getX(Length.Unit) instead.

Returns:

X coordinate value in meters.

getY

@Deprecated
double getY()

Deprecated. Use getY(Length.Unit) instead.

Returns:

Y coordinate value in meters.

getZ

@Deprecated
double getZ()

Deprecated. Use getZ(Length.Unit) instead.

Returns:

Z coordinate value in meters.

getX

double getX(Length.Unit unit)

Provides the X coordinate value in specified units.

Parameters:

unit - The length unit for which to return the X coordinate value

Returns:

The X coordinate value in specified units.

Since:

1.2.56

getY

double getY(Length.Unit unit)

Provides the Y coordinate value in specified units.

Parameters:

unit - The length unit for which to return the Y coordinate value

Returns:

The Y coordinate value in specified units.

Since:

1.2.56

getZ

double getZ(Length.Unit unit)

Provides the Z coordinate value in specified units.

Parameters:

unit - The length unit for which to return the Z coordinate value

Returns:

The Z coordinate value in specified units.

Since:

1.2.56

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 - The tolerance value to be used for the comparison of coordinate values (i.e. X, Y, Z) in specified units

unit - The length unit for the specified epsilon tolerance.

Returns:

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

Since:

1.2.56

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:

true, if the values of this Position instance and the obj argument are exactly the same; otherwise false.

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

A hash code value for this object.

Since:

1.2.56

toString

String toString()

Overrides:

toString in class Object

Returns:

A string representation of the position.

Since:

1.2.56