com.esri.arcgis.datasourcesraster

Class FrameXform

java.lang.Object

com.esri.arcgis.datasourcesraster.FrameXform

All Implemented Interfaces:

IFrameXform, IFrameXform2, IGeodataXform2, IRasterXform, ISensorXform, IGeodataXform, ITransformation, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class FrameXform
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeodataXform, IGeodataXform2, IFrameXform, IFrameXform2, IRasterXform, ISensorXform, ITransformation, IClone, IPersistStream, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'FrameXform'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A standard frame camera model transformation class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IGeodataXform2

IID, IIDa079ee4b_9e92_40ce_b83d_6bd811e33a1c, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IFrameXform2

IID, IIDae2f4ff6_4e55_43e9_96fa_f384b05e8d8c, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IFrameXform

IID68f50e4b_6e2d_4950_bd52_d9646acc8a97

Fields inherited from interface com.esri.arcgis.geodatabase.IGeodataXform

IID5e6cf525_4e74_419b_946f_7da9bfdf815d

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterXform

IID, IID45b14f29_01b8_489a_9f55_cd21ea84fd7f, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISensorXform

IID, IID4fc73b78_d994_457a_90ee_a6d0015b6548, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ITransformation

IID, IID6f2cf924_7e00_11d0_82f4_0000f8034032, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
FrameXform() Constructs a FrameXform using ArcGIS Engine.
FrameXform(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FrameXform theFrameXform = (FrameXform) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	compareCameraDefinition(IFrameXform pFrameXf) Compares if it has the same camera definition as a given frame geodata transform.
IGeometry	computeFootprint(int direction, IGeometry pExtent, int maximumVertices) Computes the footprint in a given direction for a given input extent/footprint.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
double	getAverageZ() The average Z in meters.
java.lang.String	getCameraID() The camera ID.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getConstantZ() The constant Z value in meters.
IRaster	getDEM() The Digital Elevation Model (DEM).
void	getDistortionTable(IDoubleArray[] ppDistanceInMillimeters, IDoubleArray[] ppDistortionInMicrons) The distortion tables.
IGeometryCollection	getDomains() The domains in output space.
double	getEarthRadius() The earth radius in meters.
double	getFocalLength() The focal length in micron.
IEnvelope	getFullExtent() The full output extent within which this xform is applied.
double	getImageTopAngle() The angle of the top of image.
IGeodataXform	getInteriorOrientation() The interior orientation as an affine transformation.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.Object	getKonradyParameters() The Konrady adjustment parameters.
int	getKonradyType() The Konrady calculation method.
IGeodataXform	getLSR() The LSR-To-USR conversion.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IPoint	getPerspectiveCenter() The sensor position.
java.lang.Object	getPerspectiveMatrix() The specified sensor orientation as an orthogonal rotation matrix.
int	getPerspectivePolarity() The sensor polarity.
IPoint	getPrincipalPoint() The film principal point.
IDoubleArray	getResiduals() The residuals for distortion table points.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The output spatial reference after applying this transform.
double	getZ(double x, double y) Gets Z value for a given location (x,y) in map space.
double	getZFactor() The conversion factor from DEM Z unit to meters.
double	getZOffset() The Z offset in meters applied to DEM.
int	hashCode() the hashcode for this object
boolean	isApplyCurvatureAndRefraction() Indicates if the adjustment of earth curvature and refraction is applied.
boolean	isCorrectGeoid() Indicates if Geoid correction is needed.
void	isDirty() isDirty
boolean	isEnableKonrady() Indicates if the Konrady adjustment to be applied.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isIdentity() Indicates if this geodata transform is an identity transform.
boolean	isRequireDEM() Indicates if DEM is required for applying this transform.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	prepare(int iDomain, double dx, double dy, IEnvelope pExtent) Prepares the xform for a given extent and cellsize within a domain.
void	putAircraftOrientation(double rollDeg, double pitchDeg, double headingDeg, double cameraMountAngleDeg, boolean clockwise) Sets the sensor exterior orientation (rotation matrix) using aircraft orientation angles in degrees.
void	putDistortionTable(IDoubleArray pDistanceInMillimeters, IDoubleArray pDistortionInMicrons) The distortion tables to calculate Konrady coefficients and residuals.
void	putInteriorOrientationParameters(int direction, java.lang.Object parameters) Puts the interior orientation parameters.
void	putPerspectiveAngles(double omega, double phi, double kappa, boolean clockwise) Puts the sensor exterior orientation as a set of rotation angles in degrees.
void	queryAircraftOrientation(double[] pRollDeg, double[] pPitchDeg, double[] pTopOfFrameDeg, boolean[] pClockwise) Queries aircraft orientation angles in degrees from the sensor exterior orientation (rotation matrix).
void	queryCameraAxisAngles(double[] pCameraAzimuth, double[] pCameraElevation) Computes and returns the apparent position of the camera.
void	queryKonradyParameters(double[] pK) Queries the Konrady adjustment parameterrs.
void	queryPerspectiveAngles(double[] pOmega, double[] pPhi, double[] pKappa, boolean[] pClockwise) Queries the sensor exterior orientation as a set of rotation angles in degrees.
void	queryPerspectiveMatrix(double[] pMatrix) Queries the perspective matrix.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setApplyCurvatureAndRefraction(boolean pApplyCurvatureAndRefraction) Indicates if the adjustment of earth curvature and refraction is applied.
void	setAverageZ(double averageZ) The average Z in meters.
void	setCameraID(java.lang.String pCameraID) The camera ID.
void	setConstantZ(double z) The constant Z value in meters.
void	setCorrectGeoid(boolean pCorrection) Indicates if Geoid correction is needed.
void	setDEMByRef(IRaster ppDEM) The Digital Elevation Model (DEM).
void	setEarthRadius(double radius) The earth radius in meters.
void	setEnableKonrady(boolean pK) Indicates if the Konrady adjustment to be applied.
void	setFocalLength(double length) The focal length in micron.
void	setFullExtent(IEnvelope ppFullExtent) The full output extent within which this xform is applied.
void	setImageTopAngle(double pAngle) The angle of the top of image.
void	setInteriorOrientationByRef(IGeodataXform ppAffine) The interior orientation as an affine transformation.
void	setKonradyParameters(java.lang.Object pK) The Konrady adjustment parameters.
void	setKonradyType(int pType) The Konrady calculation method.
void	setLSRByRef(IGeodataXform ppLSR) The LSR-To-USR conversion.
void	setPerspectiveCenterByRef(IPoint sp) The sensor position.
void	setPerspectiveMatrix(java.lang.Object pMatrix) The specified sensor orientation as an orthogonal rotation matrix.
void	setPerspectivePolarity(int polarity) The sensor polarity.
void	setPrincipalPointByRef(IPoint pp) The film principal point.
void	setRequireDEM(boolean pRequireDEM) Indicates if DEM is required for applying this transform.
void	setSpatialReferenceByRef(ISpatialReference spatialRefence) The output spatial reference after applying this transform.
void	setZFactor(double zFactor) The conversion factor from DEM Z unit to meters.
void	setZOffset(double zOffset) The Z offset in meters applied to DEM.
IGeodataXform	simplify() Simplifies into a simple geodataxform.
void	transform(int direction, int npoints, _WKSPoint[] points) Transforms a set of points in a given direction.
void	transform3D(int direction, int npoints, _WKSPointZ[] points) Transforms a set of 3D points in a given direction.
void	transform3DPoints(int direction, IPointCollection[] pPoints) Transforms a collection of 3D points in a given direction
void	transformCellsize(int direction, double[] dx, double[] dy, IEnvelope areaOfInterest) Transforms a cellsize in a given direction.
void	transformExtent(int direction, IEnvelope[] extent) Transforms an extent in a given direction.
void	transformMeasuresFF(int direction, int cMeasures, double[] inMeasures, double[] outMeasures) Transforms floating point measures to floating point measures (or do the inverse).
void	transformMeasuresFI(int direction, int cMeasures, double[] inMeasures, int[] outMeasures) Transforms floating point measures to integer measures (or do the inverse).
void	transformMeasuresIF(int direction, int cMeasures, int[] inMeasures, double[] outMeasures) Transforms integer measures to floating point measures (or do the inverse).
void	transformMeasuresII(int direction, int cMeasures, int[] inMeasures, int[] outMeasures) Transforms integer measures to integer measures (or do the inverse).
void	transformPoints(int direction, IPointCollection[] points) Transforms a point collection in a given direction
void	transformPointsFF(int direction, int cPoints, double[] inPoints, double[] outPoints) Transforms floating point points to floating point points (or do the inverse).
void	transformPointsFI(int direction, int cPoints, double[] inPoints, int[] outPoints) Transforms floating point points to integer points (or do the inverse).
void	transformPointsIF(int direction, int cPoints, int[] inPoints, double[] outPoints) Transforms integer points to floating point points (or do the inverse).
void	transformPointsII(int direction, int cPoints, int[] inPoints, int[] outPoints) Transforms integer points to integer points (or do the inverse).
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

FrameXform

public FrameXform()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a FrameXform using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FrameXform

public FrameXform(java.lang.Object obj)
           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FrameXform theFrameXform = (FrameXform) obj;

Construct a FrameXform using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FrameXform.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The output spatial reference after applying this transform.

Specified by:

getSpatialReference in interface IGeodataXform

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRefence)
                              throws java.io.IOException,
                                     AutomationException

The output spatial reference after applying this transform.

Specified by:

setSpatialReferenceByRef in interface IGeodataXform

Parameters:

spatialRefence - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDomains

public IGeometryCollection getDomains()
                               throws java.io.IOException,
                                      AutomationException

The domains in output space.

Specified by:

getDomains in interface IGeodataXform

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentity

public boolean isIdentity()
                   throws java.io.IOException,
                          AutomationException

Indicates if this geodata transform is an identity transform.

Specified by:

isIdentity in interface IGeodataXform

Returns:

The isIdentity

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      int npoints,
                      _WKSPoint[] points)
               throws java.io.IOException,
                      AutomationException

Transforms a set of points in a given direction.

Specified by:

transform in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

npoints - The npoints (in)

points - A Structure: com.esri.arcgis.system._WKSPoint (A com.esri.arcgis.system._WKSPoint COM typedef) (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformCellsize

public void transformCellsize(int direction,
                              double[] dx,
                              double[] dy,
                              IEnvelope areaOfInterest)
                       throws java.io.IOException,
                              AutomationException

Transforms a cellsize in a given direction.

Specified by:

transformCellsize in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

dx - The dx (in/out: use single element array)

dy - The dy (in/out: use single element array)

areaOfInterest - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformExtent

public void transformExtent(int direction,
                            IEnvelope[] extent)
                     throws java.io.IOException,
                            AutomationException

Transforms an extent in a given direction.

Specified by:

transformExtent in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPoints

public void transformPoints(int direction,
                            IPointCollection[] points)
                     throws java.io.IOException,
                            AutomationException

Transforms a point collection in a given direction

Specified by:

transformPoints in interface IGeodataXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

points - A reference to a com.esri.arcgis.geometry.IPointCollection (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform3D

public void transform3D(int direction,
                        int npoints,
                        _WKSPointZ[] points)
                 throws java.io.IOException,
                        AutomationException

Transforms a set of 3D points in a given direction.

Specified by:

transform3D in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

npoints - The npoints (in)

points - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform3DPoints

public void transform3DPoints(int direction,
                              IPointCollection[] pPoints)
                       throws java.io.IOException,
                              AutomationException

Transforms a collection of 3D points in a given direction

Specified by:

transform3DPoints in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeFootprint

public IGeometry computeFootprint(int direction,
                                  IGeometry pExtent,
                                  int maximumVertices)
                           throws java.io.IOException,
                                  AutomationException

Computes the footprint in a given direction for a given input extent/footprint.

Specified by:

computeFootprint in interface IGeodataXform2

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

pExtent - A reference to a com.esri.arcgis.geometry.IGeometry (in)

maximumVertices - The maximumVertices (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZ

public double getZ(double x,
                   double y)
            throws java.io.IOException,
                   AutomationException

Gets Z value for a given location (x,y) in map space.

Specified by:

getZ in interface IGeodataXform2

Parameters:

x - The x (in)

y - The y (in)

Returns:

The z

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simplify

public IGeodataXform simplify()
                       throws java.io.IOException,
                              AutomationException

Simplifies into a simple geodataxform.

Specified by:

simplify in interface IGeodataXform2

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteriorOrientation

public IGeodataXform getInteriorOrientation()
                                     throws java.io.IOException,
                                            AutomationException

The interior orientation as an affine transformation.

Specified by:

getInteriorOrientation in interface IFrameXform

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInteriorOrientationByRef

public void setInteriorOrientationByRef(IGeodataXform ppAffine)
                                 throws java.io.IOException,
                                        AutomationException

The interior orientation as an affine transformation.

Specified by:

setInteriorOrientationByRef in interface IFrameXform

Parameters:

ppAffine - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableKonrady

public boolean isEnableKonrady()
                        throws java.io.IOException,
                               AutomationException

Indicates if the Konrady adjustment to be applied.

Specified by:

isEnableKonrady in interface IFrameXform

Returns:

The pK

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableKonrady

public void setEnableKonrady(boolean pK)
                      throws java.io.IOException,
                             AutomationException

Indicates if the Konrady adjustment to be applied.

Specified by:

setEnableKonrady in interface IFrameXform

Parameters:

pK - The pK (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKonradyParameters

public java.lang.Object getKonradyParameters()
                                      throws java.io.IOException,
                                             AutomationException

The Konrady adjustment parameters.

Specified by:

getKonradyParameters in interface IFrameXform

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKonradyParameters

public void setKonradyParameters(java.lang.Object pK)
                          throws java.io.IOException,
                                 AutomationException

The Konrady adjustment parameters.

Specified by:

setKonradyParameters in interface IFrameXform

Parameters:

pK - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKonradyType

public int getKonradyType()
                   throws java.io.IOException,
                          AutomationException

The Konrady calculation method.

Specified by:

getKonradyType in interface IFrameXform

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterKonradyType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKonradyType

public void setKonradyType(int pType)
                    throws java.io.IOException,
                           AutomationException

The Konrady calculation method.

Specified by:

setKonradyType in interface IFrameXform

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriRasterKonradyType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryKonradyParameters

public void queryKonradyParameters(double[] pK)
                            throws java.io.IOException,
                                   AutomationException

Queries the Konrady adjustment parameterrs.

Specified by:

queryKonradyParameters in interface IFrameXform

Parameters:

pK - The pK (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplyCurvatureAndRefraction

public boolean isApplyCurvatureAndRefraction()
                                      throws java.io.IOException,
                                             AutomationException

Indicates if the adjustment of earth curvature and refraction is applied.

Specified by:

isApplyCurvatureAndRefraction in interface IFrameXform

Returns:

The pApplyCurvatureAndRefraction

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyCurvatureAndRefraction

public void setApplyCurvatureAndRefraction(boolean pApplyCurvatureAndRefraction)
                                    throws java.io.IOException,
                                           AutomationException

Indicates if the adjustment of earth curvature and refraction is applied.

Specified by:

setApplyCurvatureAndRefraction in interface IFrameXform

Parameters:

pApplyCurvatureAndRefraction - The pApplyCurvatureAndRefraction (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEarthRadius

public double getEarthRadius()
                      throws java.io.IOException,
                             AutomationException

The earth radius in meters.

Specified by:

getEarthRadius in interface IFrameXform

Returns:

The radius

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEarthRadius

public void setEarthRadius(double radius)
                    throws java.io.IOException,
                           AutomationException

The earth radius in meters.

Specified by:

setEarthRadius in interface IFrameXform

Parameters:

radius - The radius (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAverageZ

public double getAverageZ()
                   throws java.io.IOException,
                          AutomationException

The average Z in meters.

Specified by:

getAverageZ in interface IFrameXform

Returns:

The averageZ

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAverageZ

public void setAverageZ(double averageZ)
                 throws java.io.IOException,
                        AutomationException

The average Z in meters.

Specified by:

setAverageZ in interface IFrameXform

Parameters:

averageZ - The averageZ (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrincipalPoint

public IPoint getPrincipalPoint()
                         throws java.io.IOException,
                                AutomationException

The film principal point.

Specified by:

getPrincipalPoint in interface IFrameXform

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrincipalPointByRef

public void setPrincipalPointByRef(IPoint pp)
                            throws java.io.IOException,
                                   AutomationException

The film principal point.

Specified by:

setPrincipalPointByRef in interface IFrameXform

Parameters:

pp - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPerspectiveMatrix

public java.lang.Object getPerspectiveMatrix()
                                      throws java.io.IOException,
                                             AutomationException

The specified sensor orientation as an orthogonal rotation matrix.

Specified by:

getPerspectiveMatrix in interface IFrameXform

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerspectiveMatrix

public void setPerspectiveMatrix(java.lang.Object pMatrix)
                          throws java.io.IOException,
                                 AutomationException

The specified sensor orientation as an orthogonal rotation matrix.

Specified by:

setPerspectiveMatrix in interface IFrameXform

Parameters:

pMatrix - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPerspectiveMatrix

public void queryPerspectiveMatrix(double[] pMatrix)
                            throws java.io.IOException,
                                   AutomationException

Queries the perspective matrix.

Specified by:

queryPerspectiveMatrix in interface IFrameXform

Parameters:

pMatrix - The pMatrix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPerspectiveCenter

public IPoint getPerspectiveCenter()
                            throws java.io.IOException,
                                   AutomationException

The sensor position.

Specified by:

getPerspectiveCenter in interface IFrameXform

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerspectiveCenterByRef

public void setPerspectiveCenterByRef(IPoint sp)
                               throws java.io.IOException,
                                      AutomationException

The sensor position.

Specified by:

setPerspectiveCenterByRef in interface IFrameXform

Parameters:

sp - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPerspectivePolarity

public int getPerspectivePolarity()
                           throws java.io.IOException,
                                  AutomationException

The sensor polarity.

Specified by:

getPerspectivePolarity in interface IFrameXform

Returns:

The polarity

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerspectivePolarity

public void setPerspectivePolarity(int polarity)
                            throws java.io.IOException,
                                   AutomationException

The sensor polarity.

Specified by:

setPerspectivePolarity in interface IFrameXform

Parameters:

polarity - The polarity (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocalLength

public double getFocalLength()
                      throws java.io.IOException,
                             AutomationException

The focal length in micron.

Specified by:

getFocalLength in interface IFrameXform

Returns:

The length

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFocalLength

public void setFocalLength(double length)
                    throws java.io.IOException,
                           AutomationException

The focal length in micron.

Specified by:

setFocalLength in interface IFrameXform

Parameters:

length - The length (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putInteriorOrientationParameters

public void putInteriorOrientationParameters(int direction,
                                             java.lang.Object parameters)
                                      throws java.io.IOException,
                                             AutomationException

Puts the interior orientation parameters.

Specified by:

putInteriorOrientationParameters in interface IFrameXform

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

parameters - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPerspectiveAngles

public void putPerspectiveAngles(double omega,
                                 double phi,
                                 double kappa,
                                 boolean clockwise)
                          throws java.io.IOException,
                                 AutomationException

Puts the sensor exterior orientation as a set of rotation angles in degrees.

Specified by:

putPerspectiveAngles in interface IFrameXform

Parameters:

omega - The omega (in)

phi - The phi (in)

kappa - The kappa (in)

clockwise - The clockwise (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPerspectiveAngles

public void queryPerspectiveAngles(double[] pOmega,
                                   double[] pPhi,
                                   double[] pKappa,
                                   boolean[] pClockwise)
                            throws java.io.IOException,
                                   AutomationException

Queries the sensor exterior orientation as a set of rotation angles in degrees.

Specified by:

queryPerspectiveAngles in interface IFrameXform

Parameters:

pOmega - The pOmega (out: use single element array)

pPhi - The pPhi (out: use single element array)

pKappa - The pKappa (out: use single element array)

pClockwise - The pClockwise (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLSRByRef

public void setLSRByRef(IGeodataXform ppLSR)
                 throws java.io.IOException,
                        AutomationException

The LSR-To-USR conversion.

Specified by:

setLSRByRef in interface IFrameXform

Parameters:

ppLSR - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLSR

public IGeodataXform getLSR()
                     throws java.io.IOException,
                            AutomationException

The LSR-To-USR conversion.

Specified by:

getLSR in interface IFrameXform

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putDistortionTable

public void putDistortionTable(IDoubleArray pDistanceInMillimeters,
                               IDoubleArray pDistortionInMicrons)
                        throws java.io.IOException,
                               AutomationException

The distortion tables to calculate Konrady coefficients and residuals.

Specified by:

putDistortionTable in interface IFrameXform

Parameters:

pDistanceInMillimeters - A reference to a com.esri.arcgis.system.IDoubleArray (in)

pDistortionInMicrons - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistortionTable

public void getDistortionTable(IDoubleArray[] ppDistanceInMillimeters,
                               IDoubleArray[] ppDistortionInMicrons)
                        throws java.io.IOException,
                               AutomationException

The distortion tables.

Specified by:

getDistortionTable in interface IFrameXform

Parameters:

ppDistanceInMillimeters - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

ppDistortionInMicrons - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResiduals

public IDoubleArray getResiduals()
                          throws java.io.IOException,
                                 AutomationException

The residuals for distortion table points.

Specified by:

getResiduals in interface IFrameXform

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCameraID

public java.lang.String getCameraID()
                             throws java.io.IOException,
                                    AutomationException

The camera ID.

Specified by:

getCameraID in interface IFrameXform2

Returns:

The pCameraID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCameraID

public void setCameraID(java.lang.String pCameraID)
                 throws java.io.IOException,
                        AutomationException

The camera ID.

Specified by:

setCameraID in interface IFrameXform2

Parameters:

pCameraID - The pCameraID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compareCameraDefinition

public boolean compareCameraDefinition(IFrameXform pFrameXf)
                                throws java.io.IOException,
                                       AutomationException

Compares if it has the same camera definition as a given frame geodata transform.

Specified by:

compareCameraDefinition in interface IFrameXform2

Parameters:

pFrameXf - A reference to a com.esri.arcgis.datasourcesraster.IFrameXform (in)

Returns:

The pbEqual

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putAircraftOrientation

public void putAircraftOrientation(double rollDeg,
                                   double pitchDeg,
                                   double headingDeg,
                                   double cameraMountAngleDeg,
                                   boolean clockwise)
                            throws java.io.IOException,
                                   AutomationException

Sets the sensor exterior orientation (rotation matrix) using aircraft orientation angles in degrees.

Specified by:

putAircraftOrientation in interface IFrameXform2

Parameters:

rollDeg - The rollDeg (in)

pitchDeg - The pitchDeg (in)

headingDeg - The headingDeg (in)

cameraMountAngleDeg - The cameraMountAngleDeg (in)

clockwise - The clockwise (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryAircraftOrientation

public void queryAircraftOrientation(double[] pRollDeg,
                                     double[] pPitchDeg,
                                     double[] pTopOfFrameDeg,
                                     boolean[] pClockwise)
                              throws java.io.IOException,
                                     AutomationException

Queries aircraft orientation angles in degrees from the sensor exterior orientation (rotation matrix).

Specified by:

queryAircraftOrientation in interface IFrameXform2

Parameters:

pRollDeg - The pRollDeg (out: use single element array)

pPitchDeg - The pPitchDeg (out: use single element array)

pTopOfFrameDeg - The pTopOfFrameDeg (out: use single element array)

pClockwise - The pClockwise (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCameraAxisAngles

public void queryCameraAxisAngles(double[] pCameraAzimuth,
                                  double[] pCameraElevation)
                           throws java.io.IOException,
                                  AutomationException

Computes and returns the apparent position of the camera. The values for Azimuth and Elevation are in degrees.

Specified by:

queryCameraAxisAngles in interface IFrameXform2

Parameters:

pCameraAzimuth - The pCameraAzimuth (out: use single element array)

pCameraElevation - The pCameraElevation (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageTopAngle

public double getImageTopAngle()
                        throws java.io.IOException,
                               AutomationException

The angle of the top of image.

Specified by:

getImageTopAngle in interface IFrameXform2

Returns:

The pAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageTopAngle

public void setImageTopAngle(double pAngle)
                      throws java.io.IOException,
                             AutomationException

The angle of the top of image.

Specified by:

setImageTopAngle in interface IFrameXform2

Parameters:

pAngle - The pAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

public IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

The full output extent within which this xform is applied.

Specified by:

getFullExtent in interface IRasterXform

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullExtent

public void setFullExtent(IEnvelope ppFullExtent)
                   throws java.io.IOException,
                          AutomationException

The full output extent within which this xform is applied.

Specified by:

setFullExtent in interface IRasterXform

Parameters:

ppFullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepare

public void prepare(int iDomain,
                    double dx,
                    double dy,
                    IEnvelope pExtent)
             throws java.io.IOException,
                    AutomationException

Prepares the xform for a given extent and cellsize within a domain.

Specified by:

prepare in interface IRasterXform

Parameters:

iDomain - The iDomain (in)

dx - The dx (in)

dy - The dy (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstantZ

public double getConstantZ()
                    throws java.io.IOException,
                           AutomationException

The constant Z value in meters.

Specified by:

getConstantZ in interface ISensorXform

Returns:

The z

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstantZ

public void setConstantZ(double z)
                  throws java.io.IOException,
                         AutomationException

The constant Z value in meters.

Specified by:

setConstantZ in interface ISensorXform

Parameters:

z - The z (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFactor

public double getZFactor()
                  throws java.io.IOException,
                         AutomationException

The conversion factor from DEM Z unit to meters.

Specified by:

getZFactor in interface ISensorXform

Returns:

The zFactor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double zFactor)
                throws java.io.IOException,
                       AutomationException

The conversion factor from DEM Z unit to meters.

Specified by:

setZFactor in interface ISensorXform

Parameters:

zFactor - The zFactor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZOffset

public double getZOffset()
                  throws java.io.IOException,
                         AutomationException

The Z offset in meters applied to DEM.

Specified by:

getZOffset in interface ISensorXform

Returns:

The zOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZOffset

public void setZOffset(double zOffset)
                throws java.io.IOException,
                       AutomationException

The Z offset in meters applied to DEM.

Specified by:

setZOffset in interface ISensorXform

Parameters:

zOffset - The zOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDEM

public IRaster getDEM()
               throws java.io.IOException,
                      AutomationException

The Digital Elevation Model (DEM).

Specified by:

getDEM in interface ISensorXform

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

public void setDEMByRef(IRaster ppDEM)
                 throws java.io.IOException,
                        AutomationException

The Digital Elevation Model (DEM).

Specified by:

setDEMByRef in interface ISensorXform

Parameters:

ppDEM - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequireDEM

public boolean isRequireDEM()
                     throws java.io.IOException,
                            AutomationException

Indicates if DEM is required for applying this transform.

Specified by:

isRequireDEM in interface ISensorXform

Returns:

The pRequireDEM

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequireDEM

public void setRequireDEM(boolean pRequireDEM)
                   throws java.io.IOException,
                          AutomationException

Indicates if DEM is required for applying this transform.

Specified by:

setRequireDEM in interface ISensorXform

Parameters:

pRequireDEM - The pRequireDEM (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCorrectGeoid

public boolean isCorrectGeoid()
                       throws java.io.IOException,
                              AutomationException

Indicates if Geoid correction is needed.

Specified by:

isCorrectGeoid in interface ISensorXform

Returns:

The pCorrection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCorrectGeoid

public void setCorrectGeoid(boolean pCorrection)
                     throws java.io.IOException,
                            AutomationException

Indicates if Geoid correction is needed.

Specified by:

setCorrectGeoid in interface ISensorXform

Parameters:

pCorrection - The pCorrection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFF

public void transformMeasuresFF(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                double[] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Transforms floating point measures to floating point measures (or do the inverse).

Specified by:

transformMeasuresFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresFI

public void transformMeasuresFI(int direction,
                                int cMeasures,
                                double[] inMeasures,
                                int[] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Transforms floating point measures to integer measures (or do the inverse).

Specified by:

transformMeasuresFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresIF

public void transformMeasuresIF(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                double[] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Transforms integer measures to floating point measures (or do the inverse).

Specified by:

transformMeasuresIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformMeasuresII

public void transformMeasuresII(int direction,
                                int cMeasures,
                                int[] inMeasures,
                                int[] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Transforms integer measures to integer measures (or do the inverse).

Specified by:

transformMeasuresII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cMeasures - The cMeasures (in)

inMeasures - The inMeasures (in)

outMeasures - The outMeasures (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFF

public void transformPointsFF(int direction,
                              int cPoints,
                              double[] inPoints,
                              double[] outPoints)
                       throws java.io.IOException,
                              AutomationException

Transforms floating point points to floating point points (or do the inverse).

Specified by:

transformPointsFF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsFI

public void transformPointsFI(int direction,
                              int cPoints,
                              double[] inPoints,
                              int[] outPoints)
                       throws java.io.IOException,
                              AutomationException

Transforms floating point points to integer points (or do the inverse).

Specified by:

transformPointsFI in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsIF

public void transformPointsIF(int direction,
                              int cPoints,
                              int[] inPoints,
                              double[] outPoints)
                       throws java.io.IOException,
                              AutomationException

Transforms integer points to floating point points (or do the inverse).

Specified by:

transformPointsIF in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformPointsII

public void transformPointsII(int direction,
                              int cPoints,
                              int[] inPoints,
                              int[] outPoints)
                       throws java.io.IOException,
                              AutomationException

Transforms integer points to integer points (or do the inverse).

Specified by:

transformPointsII in interface ITransformation

Parameters:

direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in)

cPoints - The cPoints (in)

inPoints - The inPoints (in)

outPoints - The outPoints (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException