Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.datasourcesraster
Interface IOverviewTileParameters

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IOverviewTileParameters2
All Known Implementing Classes:
DefineOverviewsParameters, IOverviewTileParameters2Proxy, IOverviewTileParametersProxy
public interface IOverviewTileParameters
extends java.io.Serializable

COM Interface 'IOverviewTileParameters'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control overview tile parameters.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID5a70d2d7_2810_4a5b_8791_5db54aec9bcf
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IGeometry getAoiGeometry()
          The polygon within which overview tiles are created.
 double getCellSize()
          The cell size of the first level of overview tiles in the units of the coordinate system of the catalog.
 int getLevels()
          The number of levels of overview tiles created.
 int getMaximumSizeOfTopmostOverview()
          The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
 IPoint getOrigin()
          The origin of the grid containing overview tiles.
 int getOverviewFactor()
          The factor by which two neighboring overview levels differ.
 int getTileCols()
          The recommended number of pixel columns in each overview tiles.
 int getTileRows()
          The recommended number of pixel rows in each overview tiles.
 IWorkspaceName getWorkspaceName()
          The workspace name where overview raster datasets are generated and stored.
 void setAoiGeometryByRef(IGeometry ppAoiGeometry)
          The polygon within which overview tiles are created.
 void setCellSize(double pCellsize)
          The cell size of the first level of overview tiles in the units of the coordinate system of the catalog.
 void setLevels(int pLevels)
          The number of levels of overview tiles created.
 void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
          The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
 void setOriginByRef(IPoint ppOrigin)
          The origin of the grid containing overview tiles.
 void setOverviewFactor(int pOverviewFactor)
          The factor by which two neighboring overview levels differ.
 void setTileCols(int pTileColPixels)
          The recommended number of pixel columns in each overview tiles.
 void setTileRows(int pTileRowPixels)
          The recommended number of pixel rows in each overview tiles.
 void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
          The workspace name where overview raster datasets are generated and stored.
 

Field Detail

IID5a70d2d7_2810_4a5b_8791_5db54aec9bcf

static final int IID5a70d2d7_2810_4a5b_8791_5db54aec9bcf
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setAoiGeometryByRef

void setAoiGeometryByRef(IGeometry ppAoiGeometry)
                         throws java.io.IOException,
                                AutomationException
The polygon within which overview tiles are created.

Parameters:
ppAoiGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAoiGeometry

IGeometry getAoiGeometry()
                         throws java.io.IOException,
                                AutomationException
The polygon within which overview tiles are created.

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.

setOriginByRef

void setOriginByRef(IPoint ppOrigin)
                    throws java.io.IOException,
                           AutomationException
The origin of the grid containing overview tiles.

Parameters:
ppOrigin - 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.

getOrigin

IPoint getOrigin()
                 throws java.io.IOException,
                        AutomationException
The origin of the grid containing overview tiles.

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.

setCellSize

void setCellSize(double pCellsize)
                 throws java.io.IOException,
                        AutomationException
The cell size of the first level of overview tiles in the units of the coordinate system of the catalog. If this property is not specified, the default value is computed automatically.

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

getCellSize

double getCellSize()
                   throws java.io.IOException,
                          AutomationException
The cell size of the first level of overview tiles in the units of the coordinate system of the catalog. If this property is not specified, the default value is computed automatically.

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

setTileCols

void setTileCols(int pTileColPixels)
                 throws java.io.IOException,
                        AutomationException
The recommended number of pixel columns in each overview tiles.

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

getTileCols

int getTileCols()
                throws java.io.IOException,
                       AutomationException
The recommended number of pixel columns in each overview tiles.

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

setTileRows

void setTileRows(int pTileRowPixels)
                 throws java.io.IOException,
                        AutomationException
The recommended number of pixel rows in each overview tiles.

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

getTileRows

int getTileRows()
                throws java.io.IOException,
                       AutomationException
The recommended number of pixel rows in each overview tiles.

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

setLevels

void setLevels(int pLevels)
               throws java.io.IOException,
                      AutomationException
The number of levels of overview tiles created.

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

getLevels

int getLevels()
              throws java.io.IOException,
                     AutomationException
The number of levels of overview tiles created.

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

setOverviewFactor

void setOverviewFactor(int pOverviewFactor)
                       throws java.io.IOException,
                              AutomationException
The factor by which two neighboring overview levels differ.

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

getOverviewFactor

int getOverviewFactor()
                      throws java.io.IOException,
                             AutomationException
The factor by which two neighboring overview levels differ.

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

setMaximumSizeOfTopmostOverview

void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
                                     throws java.io.IOException,
                                            AutomationException
The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews. The operation continues to define a new level as long as the number of pixels of the overv?G?^??

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

getMaximumSizeOfTopmostOverview

int getMaximumSizeOfTopmostOverview()
                                    throws java.io.IOException,
                                           AutomationException
The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews. The operation continues to define a new level as long as the number of pixels of the overv?G?^??

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

setWorkspaceNameByRef

void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
                           throws java.io.IOException,
                                  AutomationException
The workspace name where overview raster datasets are generated and stored.

Parameters:
ppOverviewWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException
The workspace name where overview raster datasets are generated and stored.

Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD