com.esri.sde.sdk.pe
Class PeProjectedCS

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

public final class PeProjectedCS
extends PeCoordinateSystem

A projected coordinate system is a two-dimensional planar surface. However, the Earth's surface is three-dimensional. Transforming three-dimensional space onto a two-dimensional surface is called projection. Projection formulas are mathematical expressions that convert data from a geographical location (latitude and longitude) on a sphere or spheroid to a corresponding location (x and y) on a flat, two-dimensional surface.

A projected coordinate system inherits the components of a geographic coordinate system and also has:

Projection: The mathematical transformation used to convert from geographic coordinates to planar (projected) coordinates.
Parameters: Parameters used in the transformation. These parameters are specific to the projection.
Units: Linear measurement for coordinates on the plane.


Constructor Summary
PeProjectedCS(java.lang.String str)
          Constructor.
PeProjectedCS(java.lang.String name, PeGeographicCS geogcs, PeProjection projection, PeParameters[] parameters, PeUnit unit)
          Constructor.
 
Method Summary
 java.lang.Object clone()
          Clone a projcs.
 java.lang.Object cloneAlterUnits(PeUnit linearUnit, PeUnit angularUnit)
          Clone a PCS, change the clone's unit objects to the arguments, and convert values in appropriate parameter objects.
 void delete()
          Destructor.
static PeCoordinateSystem fromString(java.lang.String str)
          Create a projcs from a string.
 PeHorizon[] generateHorizon()
          Generate a horizon for a projected coordinate system.
 PeAuthority getAuth()
          Retrieve a projcs's authority
 int getCode()
           
 PeGeographicCS getGeogCoordSys()
          Retrieve a projcs's geogcs.
 PeMetadata getMetadata()
          Retrieve a projcs's metadata.
 java.lang.String getName()
          Retrieve a projcs's name.
 PeParameters[] getParameters()
          Retrieve a projcs's parameters into an array.
 com.esri.sde.sdk.pe.PeConstants getPCSConstants()
           
 PeProjection getProjection()
          Retrieve a projcs's projection.
 int getStatus()
          Retrieve a projcs's status.
 int getType()
          Retrieve a projcs's type.
 PeUnit getUnit()
          Retrieve a projcs's unit (linear).
 PeHorizon[] horizonGcsRasterGenerate()
          Generate a GCS Raster horizon for a projected coordinate system.
 PeHorizon[] horizonPcsGenerate()
          Generate a PCS horizon for a projected coordinate system.
 PeHorizon[] horizonPcsRasterGenerate()
          Generate a PCS Raster horizon for a projected coordinate system.
 boolean isConstLoaded()
          Are projection constants for a PCS loaded?
 boolean isEqual(PeCoordinateSystem coordsys)
          Test if two coordinate systems are identical.
 boolean isEqual(PeObject peobj)
          Check if both objects are equal.
 boolean isEqual(PeProjectedCS projcs)
          Test if two PCSs are identical.
 boolean isEqualNoName(PeProjectedCS projcs)
          Test if two projcs's are identical exept for the name
 int loadConstants()
          Load projection constants for a PCS.
 void setAuth(PeAuthority authority)
          Store an authority in a projcs.
 void setMetadata(PeMetadata metadata)
          Set a metadata
 java.lang.String toString()
          Retrieve the external representation of a projcs.
 java.lang.String toString(int mode)
          Retrieve the extended external representation of a projcs.
 void unloadConstants()
          Unload projection constants for a PCS.
 
Methods inherited from class com.esri.sde.sdk.pe.PeCoordinateSystem
fromPrjFile, fromPrjString, getAuthority, setAuthority, toPrjFile, toPrjString
 
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

PeProjectedCS

public PeProjectedCS(java.lang.String name,
                     PeGeographicCS geogcs,
                     PeProjection projection,
                     PeParameters[] parameters,
                     PeUnit unit)
              throws PeProjectionException
Constructor.

Throws:
PeProjectionException

PeProjectedCS

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

Throws:
PeProjectionException
Method Detail

fromString

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

Throws:
PeProjectionException

clone

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

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

delete

public void delete()
Destructor.

Overrides:
delete in class PeCoordinateSystem

getName

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

Specified by:
getName in class PeObject

getType

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

Specified by:
getType in class PeObject

getStatus

public int getStatus()
Retrieve a projcs'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(PeCoordinateSystem coordsys)
Test if two coordinate systems are identical.

Overrides:
isEqual in class PeCoordinateSystem

isEqual

public boolean isEqual(PeProjectedCS projcs)
Test if two PCSs are identical.


toString

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

Overrides:
toString in class PeCoordinateSystem

toString

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

Overrides:
toString in class PeCoordinateSystem

getAuth

public PeAuthority getAuth()
Retrieve a projcs's authority

Specified by:
getAuth in class PeObject

setAuth

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

Specified by:
setAuth in class PeObject

cloneAlterUnits

public java.lang.Object cloneAlterUnits(PeUnit linearUnit,
                                        PeUnit angularUnit)
                                 throws PeProjectionException
Clone a PCS, change the clone's unit objects to the arguments, and convert values in appropriate parameter objects.

Throws:
PeProjectionException

isEqualNoName

public boolean isEqualNoName(PeProjectedCS projcs)
Test if two projcs's are identical exept for the name


getGeogCoordSys

public PeGeographicCS getGeogCoordSys()
Retrieve a projcs's geogcs.


getParameters

public PeParameters[] getParameters()
Retrieve a projcs's parameters into an array.


getProjection

public PeProjection getProjection()
Retrieve a projcs's projection.


getUnit

public PeUnit getUnit()
Retrieve a projcs's unit (linear).


getMetadata

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

Overrides:
getMetadata in class PeCoordinateSystem

setMetadata

public void setMetadata(PeMetadata metadata)
Set a metadata

Overrides:
setMetadata in class PeCoordinateSystem

generateHorizon

public PeHorizon[] generateHorizon()
                            throws PeProjectionException
Generate a horizon for a projected coordinate system.

Throws:
PeProjectionException

horizonPcsGenerate

public PeHorizon[] horizonPcsGenerate()
                               throws PeProjectionException
Generate a PCS horizon for a projected coordinate system.

Throws:
PeProjectionException

horizonGcsRasterGenerate

public PeHorizon[] horizonGcsRasterGenerate()
                                     throws PeProjectionException
Generate a GCS Raster horizon for a projected coordinate system.

Throws:
PeProjectionException

horizonPcsRasterGenerate

public PeHorizon[] horizonPcsRasterGenerate()
                                     throws PeProjectionException
Generate a PCS Raster horizon for a projected coordinate system.

Throws:
PeProjectionException

loadConstants

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

Throws:
PeProjectionException

unloadConstants

public void unloadConstants()
Unload projection constants for a PCS.


isConstLoaded

public boolean isConstLoaded()
Are projection constants for a PCS loaded?


getPCSConstants

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

getCode

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