Axis (cts 1.5.2 API)

java.lang.Object
- org.cts.cs.Axis

```
public class Axis
extends Object
```
One of the fixed reference lines of a CoordinateSystem.
Usually, axis is a term reserved to cartesian coordinate systems made of several perpendicular axis. In the context of this library, Axis objects are used for any kind of coordinate system, including vertical and ellipsoidal ones.

Author:

Michaël Michaud, Jules Party

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Axis.Direction
Axis different directions.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Axis.Direction` Axis different directions.

Field Summary

Fields
Modifier and Type	Field and Description
`static Axis`	`ALTITUDE` Altitude axis.
`static Axis`	`DEPTH` Depth axis.
`static Axis`	`EASTING` Easting axis.
`static Axis`	`HEIGHT` Height axis.
`static Axis`	`LATITUDE` Latitude axis.
`static Axis`	`LONGITUDE` Longitude axis.
`static Axis`	`NORTHING` Northing axis.
`static Axis`	`SOUTHING` Southing axis.
`static Axis`	`TIME` Time axis.
`static Axis`	`WESTING` Westing axis.
`static Axis`	`x` x axis.
`static Axis`	`X` X axis.
`static Axis`	`y` y axis.
`static Axis`	`Y` Y axis.
`static Axis`	`Z` Z axis.

Constructor Summary

Constructors
Constructor and Description

Axis(String name, Axis.Direction dir)
Create a new Axis.

Constructors
Constructor and Description
`Axis(String name, Axis.Direction dir)` Create a new Axis.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`static Axis`	`getAxis(Axis.Direction dir, String name)`
`Axis.Direction`	`getDirection()` Return the direction of this Axis (NORTH, SOUTH, EAST, WEST or OTHER).
`static Axis.Direction`	`getDirection(String dir)` Return the direction correpsonding to the string in parameter.
`String`	`getName()` Return the name of this Axis (X, Y, Z, LONGITUDE, ALTITUDE,…).
`int`	`hashCode()`
`String`	`toString()` Return a String representation of this Axis.
`String`	`toWKT()` Returns a WKT representation of the axis.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EASTING
```
public static final Axis EASTING
```
    Easting axis. Used for planimetric coordinate system, generally in pair with northing.
  - NORTHING
```
public static final Axis NORTHING
```
    Northing axis. Used for planimetric coordinate system, generally in pair with easting.
  - WESTING
```
public static final Axis WESTING
```
    Westing axis. Used for planimetric coordinate system, generally in pair with southing.
  - SOUTHING
```
public static final Axis SOUTHING
```
    Southing axis. Used for planimetric coordinate system, generally in pair with westing.
  - x
```
public static final Axis x
```
    x axis. Used for planimetric coordinate system, sometimes used in place of easting.
  - y
```
public static final Axis y
```
    y axis. Used for planimetric coordinate system, sometimes used in place of northing.
  - ALTITUDE
```
public static final Axis ALTITUDE
```
    Altitude axis. Used for vertical/compound system.
  - DEPTH
```
public static final Axis DEPTH
```
    Depth axis. Used for bathymetry.
  - LATITUDE
```
public static final Axis LATITUDE
```
    Latitude axis. Used for geographic coordinate system, generally in pair with longitude.
  - LONGITUDE
```
public static final Axis LONGITUDE
```
    Longitude axis. Used for geographic coordinate system, generally in pair with latitude.
  - HEIGHT
```
public static final Axis HEIGHT
```
    Height axis. Used for 3D ellipsoidal coordinate system, generally with latitude and longitude axes.
  - X
```
public static final Axis X
```
    X axis. Used for 3D cartesian system, generally with Y and Z axes.
  - Y
```
public static final Axis Y
```
    Y axis. Used for 3D cartesian system, generally with X and Z axes.
  - Z
```
public static final Axis Z
```
    Z axis. Used for 3D cartesian system, generally with X and Y axes.
  - TIME
```
public static final Axis TIME
```
    Time axis. Not supported in CTS yet.
- Constructor Detail
  - Axis
```
public Axis(String name,
            Axis.Direction dir)
```
    Create a new Axis.
    
    Parameters:
    
    name - name of this new Axis
    
    dir - the direction of the axis (EAST, NORTH, UP, DOWN,…)
- Method Detail
  - getAxis
```
public static Axis getAxis(Axis.Direction dir,
                           String name)
```
  - getName
```
public String getName()
```
    Return the name of this Axis (X, Y, Z, LONGITUDE, ALTITUDE,…).
    
    Returns:
  - getDirection
```
public Axis.Direction getDirection()
```
    Return the direction of this Axis (NORTH, SOUTH, EAST, WEST or OTHER).
    
    Returns:
  - getDirection
```
public static Axis.Direction getDirection(String dir)
```
    Return the direction correpsonding to the string in parameter.
    
    Parameters:
    
    dir - the name of the direction
    
    Returns:
  - toWKT
```
public String toWKT()
```
    Returns a WKT representation of the axis.
    
    Returns:
  - toString
```
public String toString()
```
    Return a String representation of this Axis.
    
    Overrides:
    
    toString in class Object
    
    Returns:
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Axis

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EASTING

NORTHING

WESTING

SOUTHING

x

y

ALTITUDE

DEPTH

LATITUDE

LONGITUDE

HEIGHT

X

Y

Z

TIME

Constructor Detail

Axis

Method Detail

getAxis

getName

getDirection

getDirection

toWKT

toString

equals

hashCode