ESRI.ArcGIS.DataManagementTools Send your comments to: Site Administrator | Terms of Use | PRIVACY | Copyright @ ESRI | Careers
GenerateMapServerCache Class Members
See Also  Properties 
ESRI.ArcGIS.DataManagementTools Namespace : GenerateMapServerCache Class


The following tables list the members exposed by GenerateMapServerCache.

Public Constructors

  Name Description
Public Constructor GenerateMapServerCache Constructor Overloaded. Constructor that takes all required parameters for geoprocessor execution.  
Top

Public Properties

  Name Description
Public Property Alias The alias for this tool's toolbox.  
Public Property Antialiasing If chosen, this option will smooth edges of lines, borders and text for vector data. Antialiasing is off by default.

(In, Optional)  
Public Property built_with This parameter allows you to select where the processing for the cache creation takes place. This Computer—to build the cache using the resources of this computer. ArcGIS Server—to leverage the resources of a specified ArcGIS Server to build the cache rapidly.

(In, Required)  
Public Property data_frame The source map document map frame to cache. Only one data frame can be chosen.

(In, Optional)  
Public Property dpi The dots per inch (DPI) value should match the resolution of the output device that is used to view the map cache. If an incorrect DPI chosen does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96.

(In, Required)  
Public Property Layer Input Layers (in, Optional)  
Public Property levels A list of the various scales at which the cache will be generated. The tool gives the default scale levels based on the number of levels specified. You are able to change these values and generate the cache at the desired scale levels.Enter a single scale or a comma-delimited list of scales at which to generate the cache.

(In, Optional)  
Public Property map_document The source map document used to create the cache.

(In, Optional)  
Public Property map_or_layers Specify whether you want to generate cache with all the layers fused together, or to generate cache for each individual layer that you specify. Two cache types can be created: Fused—Each tile is created as a fused image of all the layers in the source map document. Multi-layer—There is one cache but it is organized into sub-caches containing tiles from each layer in the source map document.

If the Multi-layer option is the chosen cache type, the layers in the "Input Layers" list window will be selectable. Choose the layers desired for the cache. The "Add Value" button is never active.

{Fused | Multi-layer} (In, Optional)  
Public Property num_of_scales The number of scale levels to use when caching the source map document.

(In, Required)  
Public Property object_name The name of the MapServer configuration that will be used to generate the cache.

(In, Optional)  
Public Property out_folder The path name where the cache will be created. This should be a shared directory that is accessible by the user running this tool. If an ArcGIS Server is being used to create the cache, the Server Object Container account user on each Server Object Container machine must have access to this directory.

(In, Required)  
Public Property ParameterInfo The parameters used by this tool. For internal use only.  
Public Property scales_type Define the scale levels that should be cached. The Standard option will auto-generate the scales based on the number defined in the "Number of Scales" field. It will use levels that increase or decrease by half from 1:1000000 and will start with a level closest to the extent of the source map document. For example, if the source map document starts at 1:121,000,000 and 14 levels are defined, the scale levels will cache at:1:128,000,0001:64,000,000 1:32,000,0001:16,000,000 1:8,000,0001:4,000,000 1:2,000,000 1:1,000,000 1:500,000 1:250,000 1:125,0001:64,000 1:32,000 1:16,000.

The Custom option permits the cache designer to create a number ofscales defined by the "Number of Scales" field at any scale they wish.

(In, Required)  
Public Property server_name The host name of the ArcGIS Server Server Object Manager (SOM) that will be used to generate the cache.

(In, Optional)  
Public Property thread_count The specified number of threads to attempt to create on the client. Each thread, in turn, will try to create a server context on the map server object to generate the cache.

(In, Optional)  
Public Property tile_height Specifies the height, in pixels, of the output map tiles. Small heights may improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, there will be more edge effects, such as labeling inconsistencies that with larger sized tiles. The default tile width is 512.

(In, Required)  
Public Property tile_origin Specify the origin (upper left corner) of the tiling scheme in coordinates of the spatial reference of the source map document. The extent of the source map document must be within (but does not need to coincide) with this origin.

(In, Optional)  
Public Property tile_width Specifies the width, in pixels, of the output map tiles. Small widths may improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, there will be more edge effects, such as labeling inconsistencies, that with larger sized tiles. The default tile width is 512.

(In, Required)  
Public Property tiling_schema A tiling scheme describes how clients should reference the tiles in the cache. There is a a relationship between the spatial reference of the source map document and the tiling grid. The tiling grid uses a level of detail (scale level), row, and column referencing scheme. The scheme also defines the scale levels (levels of detail) at which the cache has tiles, the size of the tiles in the pixels and the screen resolution for which the tiles are intended to be commonly displayed.A tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme tool.

(In, Optional)  
Public Property tiling_scheme_type Choose between a new or a predefined tiling scheme.A tiling scheme describes how clients should reference the tiles in the cache. There is a a relationship between the spatial reference of the source map document and the tiling grid. The tiling grid uses a level of detail (scale level), row, and column referencing scheme. The scheme also defines the scale levels (levels of detail) at which the cache has tiles, the size of the tiles in the pixels and the screen resolution for which the tiles are intended to be commonly displayed.A tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme tool.

(In, Required)  
Public Property ToolboxDirectory The directory of this tool's toolbox.  
Public Property ToolboxName The name of this tool's toolbox.  
Public Property ToolName The name of this tool.  
Top

See Also