A Landscape Evaluation Decision Support System
Alachua County, Florida

UMB v3.0 - Programmer's Manual

System Requirements
Directory Structure
Grid Naming Structure
Required Object Libraries for VBA
Working with the UMB Source Code

System Requirements

Software:

ArcGIS 9.X
Spatial Analyst 9.X

Hardware:

Available hard drive space

Note: These are minimum requirements. If you choose to use a small cell size or a large number of input datasets UMB can and will take up large amounts of hard drive space and can take a very long time to complete its run.

Directory Structure

Output Directory: This is the folder that the user specifies when defining the model. The folder must already exist, and it must not already contain output from a previous model run.

Within the output directory there are 3 files and 1 subfolder.

\Model_Datasets - The folder containing the intermediate datasets from the UMB analysis. These datasets are used by the Traceback tool to show the user how the final result was calculated.
MapName.mxd - The output MXD containes a table of contents which shows all the intermediate and final output datasets. The filename with match the Model Name of the model run.
Schema.xml - The XML file containing the model definition for this run. This file can be loaded as an existing model definition for a new model run using the Run and Configure Model command.
SchemaResult.xml - The XML file containing metadata about the UMB analysis.
Statistics.html - The HTML file containing the statistical report for the final output.

Grid Naming Structure

Almost all GRIDs are created with a naming structure based on the first nine characters of the input dataset or theme name to which the GRID relates. This "Base" name then has up to four characters added to it to identify the individual step in the processing to which it belongs.

The absence of any of the following suffixes indicates that a layer is the starting point for a processing series.

"_ok" : The raster with values that have been reclassified.

"_NN" : (Non-Null) The raster that has had all "NoData" cells converted to a value based on the user's input.

"_rw" : The raster after it has been converted to a floating-point raster.

"_nor": The raster that has been normalized to as 0-1 scale by dividing the entire GRID by the maximum value found within the GRID.

"_wt": The raster that has been weighted in preparation for combination with other weighted GRIDs.

"_mk": The mask raster with values that have been reclassified.

"_mkN" : The mask raster that has had all "NoData" cells converted to a value based on the user's input.

Other GRIDs generated:

"base_nodata" : establishes the extent and cell size for the analysis and serves as the extent provider for all analysis if no hardmask exists.

"hard_mask" : limits the "base" grid to the extent of the hardmaskand serves as the extent and cell size provider for all analysis if a hardmask is selected.

"soft_msk" : the softmask used to set areas not to be considered in the analysis to a NoData value.

"final" : The final UMB output as a floating-point raster.

"final_class10" : The final UMB output classfied into 10 uniform classes.

Required Object Libraries for VBA

Name	Description
VBA	Visual Basic For Applications
esriFramework	ESRI Framework Object Library
Normal
VBAEXT	Microsoft Visual Basic for Applications Extensibility 5.3
esriArcMap	ESRI ArcMap Object Library
esriSystem	ESRI System Object Library
esriSystemUI	ESRI SystemUI Object Library
esriGeometry	ESRI Geometry Object Library
esriDisplay	ESRI Display Object Library
esriGeoDatabase	ESRI GeoDatabase Object Library
esriDataSourcesRaster	ESRI DataSourcesRaster Object Library
esriDataSourcesOleDB	ESRI DataSourcesOleDB Object Library
esriDataSourcesFile	ESRI DataSourcesFile Object Library
esriDataSourcesGDB	ESRI DataSourcesGDB OBJECT Library
esriOutput	ESRI Output Object Library
esriGeoDatabaseDistributed	ESRI GeoDatabaseDistributed Object Library
esriCarto	ESRI Carto Object Library
esriLocation	ESRI Location Object Library
esriSpatialAnalyst	ESRI SpatialAnalyst Object Library
esriGeoDatabaseUI	ESRI GeoDatabaseUI Object Library
esriCatalog	ESRI Catalog Object Library
esriCatalogUI	ESRI CatalogUI Object Library
esriCartoUI	ESRI CartoUI Object Library
esriDataSourcesRasterUI	ESRI DataSourcesRasterUI Object Library
esriDisplayUI	ESRI DisplayUI Object Library
esriOutputUI	ESRI OutputUI Object Library
esriArcMapUI	ESRI ArcMapUI Object Library
esriArcCatalogUI	ESRI ArcCatalogUI Object Library
esriSpatialAnalystUI	ESRI SpatialAnalystUI Object Library
esriLocationUI	ESRI LocationUI Object Library
esriGeoprocessing	ESRI Geoprocessing Object Library
MSForms	Microsoft Forms 2.0 Object Library
Scripting	Microsoft Scripting Runtime
Shell32	Microsoft Shell Controls and Automation
ComCtl32	Microsoft Windows Common Controls 5.0 (SP2)
UICONTROLSLib	ESRI UIControls
Stdole	OLE Automation
UMB	Universal Model Builder

Working with the UMB Source Code

The UMB source code is located in two sections:

1) The UMB DLL Core - The code for the UMD model core is compiled into a DLL file which is registered on the local computer during installtion. The source code can be found in the UMB installation directory, which is typically C:\Program Files\Universal Model Builder\src\. To view or edit the code in Visual Basic 6, open the file UMBGroup.vbg. Once you make changes, recompile UMB.dll and replace the existing DLL found in C:\Program Files\Universal Model Builder\bin\.

2) The Customized MXD - The MXD contains VBA code for creating the user interface in ArcMap. The MXD is typically located at C:\Program Files\Universal Model Builder\UMB3.0.mxd. To view/edit the code, open the MXD, then go to Tools, Macros, Visual Basic Editor. Once you make changes, simply save the MXD.