com.esri.arcgis.geodatabase
Interface IGeometryResultOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
GeometryResultOptions

public interface IGeometryResultOptions
extends Serializable

Provides access to methods that control geometry options.

Description

This interface is new at ArcGIS 9.3.

Remarks

IGeometryResultOptions has properties used to modify output geometry. Modification can include densification (DensifyGeometries) or generalization (GeneralizeGeometries).

Values for MaximumSegmentLength, MaximumDeviation or MaximumAllowableOffset should be in the units of the map's spatial reference unless the returned geometry is asked to be in another spatial reference (in the case of QueryFeatureData or QueryFeatureData2). For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumSegmentLength, MaximumDeviation or MaximumAllowableOffset must be in meters. In case IQueryFilter.OutputSpatialReference is set to a spatial reference unit in feet, then those values should be in feet.

When GeneralizeGeometries is set to true, the MaximumAllowableOffset property should also be set. When DensifyGeometries is set to true, MaximumDeviation and MaximumSegmentLength should also be set. For more information please see Densify and Generalize .

Product Availability

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


Method Summary
 double getMaximumAllowableOffset()
          The maximum allowable offset.
 double getMaximumDeviation()
          The maximum deviation.
 double getMaximumSegmentLength()
          The maximum segment length.
 boolean isDensifyGeometries()
          Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.
 boolean isGeneralizeGeometries()
          Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.
 void setDensifyGeometries(boolean doDensify)
          Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.
 void setGeneralizeGeometries(boolean doGeneralize)
          Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.
 void setMaximumAllowableOffset(double maxOffset)
          The maximum allowable offset.
 void setMaximumDeviation(double maxDev)
          The maximum deviation.
 void setMaximumSegmentLength(double maxSegLen)
          The maximum segment length.
 

Method Detail

isDensifyGeometries

boolean isDensifyGeometries()
                            throws IOException,
                                   AutomationException
Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.

Remarks

When DensifyGeometries is set to true, MaximumDeviation and MaximumSegmentLength should also be set. For more information please see Densify.

Product Availability

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

Returns:
The doDensify
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDensifyGeometries

void setDensifyGeometries(boolean doDensify)
                          throws IOException,
                                 AutomationException
Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.

Product Availability

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

Parameters:
doDensify - The doDensify (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumSegmentLength

double getMaximumSegmentLength()
                               throws IOException,
                                      AutomationException
The maximum segment length.

Remarks

Default value for MaximumSegmentLength is -1. Values for MaximumSegmentLength must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumSegmentLength must be in meters.

Product Availability

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

Returns:
The maxSegLen
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumSegmentLength

void setMaximumSegmentLength(double maxSegLen)
                             throws IOException,
                                    AutomationException
The maximum segment length.

Product Availability

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

Parameters:
maxSegLen - The maxSegLen (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumDeviation

double getMaximumDeviation()
                           throws IOException,
                                  AutomationException
The maximum deviation.

Remarks

Default value for MaximumDeviation is 0. Values for MaximumDeviation must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumDeviation must be in meters.

Product Availability

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

Returns:
The maxDev
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumDeviation

void setMaximumDeviation(double maxDev)
                         throws IOException,
                                AutomationException
The maximum deviation.

Product Availability

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

Parameters:
maxDev - The maxDev (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGeneralizeGeometries

boolean isGeneralizeGeometries()
                               throws IOException,
                                      AutomationException
Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.

Remarks

When GeneralizeGeometries is set to true, the MaximumAllowableOffset property should also be set. For more information please see Generalize.

Product Availability

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

Returns:
The doGeneralize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeneralizeGeometries

void setGeneralizeGeometries(boolean doGeneralize)
                             throws IOException,
                                    AutomationException
Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.

Product Availability

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

Parameters:
doGeneralize - The doGeneralize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumAllowableOffset

double getMaximumAllowableOffset()
                                 throws IOException,
                                        AutomationException
The maximum allowable offset.

Remarks

Default value for MaximumAllowableOffset is 0. Values for MaximumAllowableOffset must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumAllowableOffset must be in meters.

Product Availability

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

Returns:
The maxOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumAllowableOffset

void setMaximumAllowableOffset(double maxOffset)
                               throws IOException,
                                      AutomationException
The maximum allowable offset.

Product Availability

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

Parameters:
maxOffset - The maxOffset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.