com.esri.sde.sdk.pe
Class PeVerttran

java.lang.Object
  extended by com.esri.sde.sdk.pe.PeObject
      extended by com.esri.sde.sdk.pe.PeVerttran
All Implemented Interfaces:
java.lang.Cloneable

public final class PeVerttran
extends PeObject

This class defines the methods for a vertical transformation.


Constructor Summary
PeVerttran(java.lang.String str)
          Constructor.
PeVerttran(java.lang.String name, PeCoordinateSystem coordsys, PeVertCS vertcs1, PeVertCS vertcs2, PeVTMethod vtmethod, PeParameters[] parameters)
          Constructor.
 
Method Summary
 java.lang.Object clone()
          Clone a verttran;.
 void delete()
          Deconstructor.
static PeVerttran fromString(java.lang.String str)
          Create a verttran from a string.
 PeAuthority getAuth()
          Retrieve a verttran's authority
 int getCode()
           
 PeCoordinateSystem getCoordsys()
          Retrieve a VT's Coordinate System.
 PeMetadata getMetadata()
          Retrieve a verttran's metadata.
 java.lang.String getName()
          Retrieve a verttran's name.
 PeParameters[] getParams()
          Retrieve a verttran's parameter array.
 int getStatus()
          Get the this object's status.
 int getType()
          Retrieve a verttran's type.
 PeVertCS getVertcs1()
          Retrieve a VT's 1st Vertical Coordinate System.
 PeVertCS getVertcs2()
          Retrieve a VT's 2nd Vertical Coordinate System.
 com.esri.sde.sdk.pe.PeConstants getVTConstants()
           
 PeVTMethod getVTMethod()
          Retrieve a VT's method.
 boolean isConstLoaded()
          Checks if constants for a VT are loaded.
 boolean isEqual(PeObject peobject)
          Check if both pe objects are equal.
 boolean isEqual(PeVerttran verttran)
          Test if two verttrans are identical.
 int loadConstants()
          Load constants for a VT.
 void setAuth(PeAuthority authority)
          Store an authority in a verttran.
 void setMetadata(PeMetadata metadata)
          Set a metadata
 java.lang.String toString()
          Retrieve the external representation of a verttran.
 java.lang.String toString(int mode)
          Retrieve the extended external representation of a verttran.
 void unloadConstants()
          Unload constants for a VT.
 
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

PeVerttran

public PeVerttran(java.lang.String name,
                  PeCoordinateSystem coordsys,
                  PeVertCS vertcs1,
                  PeVertCS vertcs2,
                  PeVTMethod vtmethod,
                  PeParameters[] parameters)
           throws PeProjectionException
Constructor.

Throws:
PeProjectionException

PeVerttran

public PeVerttran(java.lang.String str)
           throws PeProjectionException
Constructor.

Throws:
PeProjectionException
Method Detail

fromString

public static PeVerttran fromString(java.lang.String str)
                             throws PeProjectionException
Create a verttran from a string.

Throws:
PeProjectionException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone a verttran;.

Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

delete

public void delete()
Deconstructor.

Specified by:
delete in class PeObject

getName

public java.lang.String getName()
Retrieve a verttran's name.

Specified by:
getName in class PeObject

getType

public int getType()
Retrieve a verttran's type.

Specified by:
getType in class PeObject

getStatus

public int getStatus()
Get the this object's status.

Specified by:
getStatus in class PeObject

isEqual

public boolean isEqual(PeObject peobject)
Check if both pe objects are equal.

Specified by:
isEqual in class PeObject

isEqual

public boolean isEqual(PeVerttran verttran)
Test if two verttrans are identical.


toString

public java.lang.String toString()
Retrieve the external representation of a verttran.

Specified by:
toString in class PeObject

toString

public java.lang.String toString(int mode)
Retrieve the extended external representation of a verttran.

Specified by:
toString in class PeObject

getAuth

public PeAuthority getAuth()
Retrieve a verttran's authority

Specified by:
getAuth in class PeObject

setAuth

public void setAuth(PeAuthority authority)
Store an authority in a verttran.

Specified by:
setAuth in class PeObject

getMetadata

public PeMetadata getMetadata()
Retrieve a verttran's metadata.


setMetadata

public void setMetadata(PeMetadata metadata)
Set a metadata


getVTMethod

public PeVTMethod getVTMethod()
Retrieve a VT's method.


getCoordsys

public PeCoordinateSystem getCoordsys()
Retrieve a VT's Coordinate System.


getVertcs1

public PeVertCS getVertcs1()
Retrieve a VT's 1st Vertical Coordinate System.


getVertcs2

public PeVertCS getVertcs2()
Retrieve a VT's 2nd Vertical Coordinate System.


loadConstants

public int loadConstants()
                  throws PeProjectionException
Load constants for a VT.

Throws:
PeProjectionException

unloadConstants

public void unloadConstants()
Unload constants for a VT.


isConstLoaded

public boolean isConstLoaded()
Checks if constants for a VT are loaded.


getParams

public PeParameters[] getParams()
Retrieve a verttran's parameter array.


getVTConstants

public com.esri.sde.sdk.pe.PeConstants getVTConstants()

getCode

public int getCode()
Specified by:
getCode in class PeObject