com.esri.sde.sdk.pe
Class PeVertCS

java.lang.Object
  com.esri.sde.sdk.pe.PeObject
      com.esri.sde.sdk.pe.PeVertCS

All Implemented Interfaces:

java.lang.Cloneable

public final class PeVertCS
extends PeObject

Vertical Coordinate System

Constructor Summary

PeVertCS(java.lang.String str)
Constructor.

PeVertCS(java.lang.String name, PeHVDatum hvdatum, PeParameters[] parameters, PeUnit unit)
Defines a new vertical coordinate system from the given specification.

Method Summary

java.lang.Object	clone() Clone a vertcs.
java.lang.Object	cloneAlterUnit(PeUnit linearUnit) Creates a clone of the vertical coordinate system object.
void	delete() Destructor.
static PeVertCS	fromString(java.lang.String str) Create a vertcs from a string.
PeAuthority	getAuth() Retrieve a vertcs's authority
int	getCode()
PeHVDatum	getHVDatum() Returns a horizontal or vertical datum from the vertical coordinate system.
PeMetadata	getMetadata() Retrieve a vertcs's metadata.
java.lang.String	getName() Retrieve a vertcs's name.
PeParameters[]	getParameters() Retrieves the array of parameters of a vertical coordinate system.
int	getStatus() Retrieve a vertcs's status.
int	getType() Retrieve a vertcs's type.
PeUnit	getUnit() Retrieves the linear unit object from a vertical coordinate system.
boolean	isEqual(PeObject peobj) Check if both objects are equal.
boolean	isEqual(PeVertCS vertcs) Tests whether two vertical coordinate system objects are equivalent.
void	setAuth(PeAuthority authority) Store an authority in a vertcs.
void	setMetadata(PeMetadata metadata) Set a metadata
java.lang.String	toString() Retrieve the external representation of a vertcs.
java.lang.String	toString(int mode) Retrieve the extended external representation of a vertcs.

Methods inherited from class com.esri.sde.sdk.pe.PeObject

fromAnyString, fromStringByType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PeVertCS

public PeVertCS(java.lang.String name,
                PeHVDatum hvdatum,
                PeParameters[] parameters,
                PeUnit unit)
         throws PeProjectionException

Defines a new vertical coordinate system from the given specification. The PeHVDatum is a supertype for either a horizontal or vertical datum. If the vertical coordinate system is gravity-related, use a vertical datum. If the vertical coordinate system is spheroid- or ellipsoid-based, use a horizontal datum. A vertical coordinate system has two parameters

Vertical_Shift Direction

The Direction can be either +1.0 or -1.0. The former value specifies that the z values are positive 'up', or heights. The latter value (-1.0) specifies that the z values are positive 'down', or depths, such as soundings on a nautical chart.

Throws:

PeProjectionException

PeVertCS

public PeVertCS(java.lang.String str)
         throws PeProjectionException

Constructor.

Throws:

PeProjectionException

Method Detail

fromString

public static PeVertCS fromString(java.lang.String str)
                           throws PeProjectionException

Create a vertcs from a string.

Throws:

PeProjectionException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone a vertcs.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

delete

public void delete()

Destructor.

Specified by:

delete in class PeObject

getName

public java.lang.String getName()

Retrieve a vertcs's name.

Specified by:

getName in class PeObject

getType

public int getType()

Retrieve a vertcs's type.

Specified by:

getType in class PeObject

getStatus

public int getStatus()

Retrieve a vertcs's status.

Specified by:

getStatus in class PeObject

isEqual

public boolean isEqual(PeObject peobj)

Check if both objects are equal.

Specified by:

isEqual in class PeObject

isEqual

public boolean isEqual(PeVertCS vertcs)

Tests whether two vertical coordinate system objects are equivalent.

toString

public java.lang.String toString()

Retrieve the external representation of a vertcs.

Specified by:

toString in class PeObject

toString

public java.lang.String toString(int mode)

Retrieve the extended external representation of a vertcs.

Specified by:

toString in class PeObject

getAuth

public PeAuthority getAuth()

Retrieve a vertcs's authority

Specified by:

getAuth in class PeObject

setAuth

public void setAuth(PeAuthority authority)

Store an authority in a vertcs.

Specified by:

setAuth in class PeObject

getMetadata

public PeMetadata getMetadata()

Retrieve a vertcs's metadata.

setMetadata

public void setMetadata(PeMetadata metadata)

Set a metadata

getHVDatum

public PeHVDatum getHVDatum()

Returns a horizontal or vertical datum from the vertical coordinate system. A vertical coordinate system has two types. If the vertical coordinate system is gravity-related, this function will return a vertical datum PeVDatum. If the vertical coordinate system is spheroid-based, a datum is returned PeDatum. The PeHVDatum structure is a supertype that supports either datum type.

getParameters

public PeParameters[] getParameters()

Retrieves the array of parameters of a vertical coordinate system. A vertical coordinate system has two parameters: Vertical_Shift and Direction. The Direction determines whether the z values are positive 'up' (heights) or 'down' (depths).

getUnit

public PeUnit getUnit()

Retrieves the linear unit object from a vertical coordinate system.

cloneAlterUnit

public java.lang.Object cloneAlterUnit(PeUnit linearUnit)
                                throws PeProjectionException

Creates a clone of the vertical coordinate system object. The new vertical coordinate system has a new unit of measure. The Vertical_Shift parameter uses the same units as the coordinate system and the value is converted to the new unit.

Returns:

a new vertical coordinate system object on success. If the original PeVertCS is invalid, null is returned. If the PeVertCS is valid, but the unit of measure parameter is null or invalid, a clone of the original vertcs is returned. If the unit object is valid, a clone of the PeVertCS with the appropriately updated unit and parameter is returned.

Throws:

PeProjectionException

getCode

public int getCode()

Specified by:

getCode in class PeObject