BA_Check_Folder_Type: Check to see if a folder is an aoi or basin folder depending on typeKey passed in
BA_ContainsSpace: Checks input string for spaces
BA_CreateRangeArray: Use the min, max, and interval values to propogate values of a rangearray
BA_DisplayRaster: Adds the specified DEM extent layer to ArcMap. DisplayName if specified, is used as the layer name in the TOC in ArcMap
BA_DisplayVector: Adds the specified vector layer to ArcMap. DisplayName if specified, is used as the layer name in the TOC in ArcMap
BA_Enable_SAExtension: Enable Spatial Analyst Extension if it's not already enabled
BA_Feature2RasterDouble: Converts numerical values with decimal values to integers so that they can source the creation of an integer value
BA_Feature2RasterInteger: Checks to make sure all values in field are whole numbers so result is an integer raster
BA_File_Exists: Uses IDEUtilities to check if a file exists
BA_File_Exists2: Uses IRasterWorkspace to check if a file exists
BA_GetBareName: Extract file name and parent folder from a full file path
BA_GetBareNameAndExtension: get the last folder (or filename) from a path string. Extension is in form of string (Shapefile) or (Raster). This string is appended to the settings file when it is saved
BA_GetPath: Generates the path when provided with the folder base and PublicPath enum value
BA_GetRasterStats: Get IRasterStatistics and raster resolution
BA_GetShapeArea: Returns the summed area of all polygons in a shapefile
BA_OpenFeatureClassFromFile: Opens and returns an IFeatureClass object
BA_OpenRasterFromFile: Opens and returns an IGeoDataSet (raster) object
BA_OpenTableFromFile: Opens and returns an ITable object
BA_QueryAttributeTable: query the attribute table of a shapefile using the value of one field to return the value of another
BA_Raster2PolygonShapefile: Convert raster file to polygon shapefile
BA_Raster2PolygonShapefileFromPath: Alternate version of BA_Raster2PolygonShapefile; Uses filepaths rather than datasets as input for the conversion
BA_Read_FolderType_File: Read the first line of the folder_type file
BA_Remove_Folder: Remove a folder and its contents recursively using Windows.IO api
BA_Remove_Raster: Delete a raster file using IRasterWorkspace object
BA_Remove_Shapefile: Remove a shapefile and its associated files
BA_Remove_Table: Delete a table (.dbf) using IFeatureWorkspace object
BA_RenameRaster: Rename a raster file
BA_RenameWorkspace: Rename a folder
BA_SaveFeatureClass: Save shapefile in a user specified folder; The folder needs to be created first
BA_SaveRasterDataset: Save raster dataset in a user specified folder; The folder needs to be created first
BA_SaveTable: Save table in a user specified folder; The folder needs to be created first
BA_SetDefaultProjection: Set map frame to the default map projection, i.e., NAD_1983_Albers USGS
BA_SetSettingsPath: Sets the settings path in the HruExtension. Checks for BAGIS, TMP, TEMP, and AGSDESKTOPJAVA in that order. Converted VBA BAGIS function. Customized templates will be stored here.
BA_Shapefile_Exists: Check if a shapefile exists
BA_Workspace_Exists: Check if a folder exists
BA_Raster2LineShapefile: Converts a raster to a polyline shapefile; Can only output a shapefile due to ArcObjects bug
BA_DisplayRasterWithSymbol: Adds the specified raster layer to ArcMap; DisplayName if specified, is used as the layer name in the TOC in ArcMap
BA_GetPointMapSymbology: Returns the symbology for the supplied point dataset (Snotel, Snow Course, etc.)
BA_GetRasterMapSymbology: Returns the symbology for the supplied raster dataset (Aspect, Slope, etc.)
BA_MapDisplayPointMarkers: Displays the point layer with symbology in the current document
BA_ReclassRasterAttributes: Converted BAGIS subroutine; Updates raster attribute table from supplied BA_IntervalList
BA_RemoveLayers: Remove all layers with the specified name from the data frame
BA_RemoveLayersFromWorkspace: Loops through layers in map. Removes them from map if they are in the supplied workspace
BA_ToggleView: Toggle view to/from layout view
BA_ZoomToAOI: Zoom map display to AOI envelope
BA_AddLineLayer: Adds a polyline feature class to ArcMap display
BA_GetBasinEnvelope: Returns the IEnvelope of a basin. Uses the buffered AOI shapefile as the extent
BA_ClipAOIRaster: Clip raster to an AOI vector. Options are no buffer, standard buffer, and PRISM buffer
BA_ClipAOIVector: Clip vector to an AOI vector. Options are no buffer or standard buffer buffer
BA_GetPRISMName: Generates the path and file name of the desired PRISM layer
BA_ListLayersinAOI: Returns arrays of raster and vector files in a given workspace (folder)
BA_ReadReclassRasterAttribute: Add name, lbound, ubound attributes to raster. These attributes are used when displaying/symbolizing the raster
BA_RemoveLayersInFolder: Remove all the layers from the map document that are in the specified folder
BA_SliceRaster: Uses Geoanalyst IReclassOp tool to slice a raster
Excel_CountRecords: Returns Long instead of Integer in case we have many rows
Excel_CopyCells: Returns Short instead of Integer; Now takes row number in addition to column number as input
Excel_CopyRangeCells: Returns Short instead of Integer
This is a new module in VB.NET. All constants are being consolidated here rather than in ModulePublic. Per .NET coding convention, constant names will be in all capital letters. ie: BA_MAP_PSEUDO_REPRESENTATION
This module contains definitions for all structures in the project.
BA_IntervalList: Inherited structure from BAGIS. Used for classifying/symbolizing maps
BA_Map_Symbology: Stores properties that are combined to symbolize layers
BA_DataStatistics: Stores layer statistics derived from IDataStatistics object. These statistics are then passed between subroutines
This module contains subroutines that use ESRI Geoprocessor object. The public methods offer signatures to configure various Geoprocessor tools. These public methods pass the Geoprocessor tool to a private method that actually calls the Geoprocessor object.
BA_CopyTableToArray: Copies an ITable to a multi-dimensional array. The list of fields to copy is passed in in a String array
BA_CreateReclass: Creates a reclass string from an array of ReclassItem() to be used as input for the Geoprocessor Reclassify tool
BA_GetDataSet: Returns an IGeoDataSet when provided with a file path and name. Contains logic to open either a feature class or a raster dataset. Knowledge of file format is not required to call this subroutine.
BA_InvokeTool: Sample of invoking a Geoprocessing tool using the GPToolCommandHelper. This example uses the Clip tool. This subroutine is not currently used by BAGIS.
BA_IsIntegerRaster: Opens a raster and checks the properties to see if it is an integer raster
BA_ListGPEnvironmentSettings: Informational function to dump the GP environment settings to the console. This function is not currently being used by BAGIS.
BA_ReclassifyRasterFromTable: Uses the Geoprocessor reclassify tool to reclassify a raster from an array of ReclassItem(). Use when you need to specify the reclassField. Otherwise use BA_ReclassRasterFromTable.
BA_Remove_Workspace: Use Geoprocessor to delete a workspace (folder)
BA_Resample_Raster: Use Resample geoprocessing tool to resample raster to specified cellSize
BA_ZonalStats2Att: Calculates specified zonal statistic and adds it as a column to the specified zone file
BA_ZoneOverlay: Uses the Geoprocessing Combine tool to combine a list of layers into a single output. The output is masked to the mask file provided. Adding outputs to the map and overwriting pre-existing outputs are options.
This module contains utility functions for extracting information from enumerations
BA_EnumDescription: Returns description attribute of an enum constant; Use if spaces/mixed case required to describe an enum value
BA_FieldNameFromStatisticEnum: Returns ArcObjects generated field name when provided with an esriGeoAnalysisStatisticsEnum. The source enum only contains integers.
BA_FieldNameFromTypeString: Returns the ArcObjects generated field name for a StatisticsTypeString
BA_GetActionParameter: Returns the ActionParameter enum entry associated with the ActionParameter's String <Description>
BA_GetEsriSliceType: Returns the esriGeoAnalysisSliceEnum entry associated with a String description of the slice type. The source enum only contains integers.
BA_GetEsriSliceTypeText: Inverse of BA_GetEsriSliceType. Returns a String description of the slice type when provided with an esriGeoAnalysisSliceEnum. The source enum only contains integers.
BA_GetMapsLayerName: Returns the MapsLayerName enum associated with the supplied layer name text; If not, returns nothing
BA_GetMeasurementUnit: Returns the MeasurementUnit entry associated with the MeasurementUnit's String <Description>
BA_GetPrismDataRange: Returns the PrismDataRange entry associated with the PrismDataRange's String <Description>
BA_GetPrismFolderName: Returns the String <Description> associated with an AOIPrismFolderNames entry corresponding to the provided index. Translates index to folder name in Weasel file structure
BA_GetRuleType: Returns the HruRuleType enum associated with String <Description> that is passed in
BA_GetSlopeUnit: Returns the SlopeUnit entry associated with the SlopeUnit's String <Description> that is passed in
BA_ListOfLayerNamesWithStyles: Returns a list of file names that have that have style names associated with them. As of June 2011 not sure this is still true as MapsFileName has been used for other purposes. Default style used if style not found.
ActionParameter: Used in template rules. Each template rule has a collection of actions defined by the ActionType enum. Each action has a set of parameters defined by this enum. These keys allow the parameters to be retrieved when the rule is run and recorded in the process log.
ActionType: Used in template rules. Each template rule has a collection of actions defined in this ActionType enum. Each action has supporting code to execute it.
AOIClipFile: Stores file names by key for files that are used for clipping
AOIMessageKey: Provides strings to be added to messages; Replaces string MessageKey in some AOIModule methods
AOIPrismFolderNames: List of Prism folder names according to Weasel file structure
BA_HelpTopics: Provides a key to link Help buttons on user forms with help content
BA_ReturnCode: List of success/failure codes returned by BAGIS functions
DAFlowByParam: Lists options for running the DA-Flow rule
FactorStatus: Indicates if a rule has been run. String is displayed on Define Zones grid
HruRuleType: Index of BAGIS-HD rules. Must be kept in sync with FrmHruZone.CboRuleType items
LayerType: List of layer types. Raster or vector.
MapsAddLayerOptions: Lists possible actions when adding a map layer. Add/replace and zoom
MapsDisplayStyle: Stores keys for display style of maps (aspect, elevation, etc.)
MapsFileName: Stores map file names by key
MapsLayerName: Stores map layer names by key for maps that are symbolized (Snotel, Snow course, etc.)
MapsMarkerType: Stores keys for map marker types (Pourpoint, Snotel, etc.)
PublicPath: Stores paths by key for weasel and AOI folder structures
StatisticsFieldName: Stores field names for source tables that store statistics; Field names are auto-generated by ArcObjects
StatisticsTypeString: Stores statistics types used by zonal statistics routines
BA_AddShapeAreaToAttrib : returns Integer by writing shape area to an attribute field
BA_GetDataStatistics: provides stats for vector files
BA_AddCTAndNonCTToAttrib: add the contiguous and non-contiguous field
BA_CopyAttribRasterToVector: Copy attribute fields from source Raster to destination vector or Raster
BA_CopyAttribRasterToRaster: Copy attribute from source Raster to destination Raster
BA_AddRasFilter: returns filter on a raster
==============================================
BA_FeatureToRasterNumeric: converts featureclass to integer raster
BA_NumFieldList: returns stringlist of fields
BA_Eliminate: eliminates polygons on area/percentile
BA_ QueryFeatureClass:returns Integer
BA_SortFeatureClass: returns Double
BA_CountFeaturesSmallerThanOrEqualTo: return the number of polygon features whose areas are smaller than or equal to a user specified value (unit in square Km)
BA_GetFeatureCount: function returns a number of features in a shapefile.
BA_GetLayerIndexByName: return the index of the layer whose name matches specified string, -1 if no match.
BA_GetLayerAttributebyPoint: return the value of the specified field of the polygon feature that contains the location of the input point geometry
BA_GetPercentileValueFromFeatureClass: return area percentile value of a polygon feature class
BA_StandardizePathString: regardless the input path format, returns a path string with or without padding backslach ("\")
BA_StandardizeShapefileName: regardless the input name format, returns a shapefile name with or without .shp extension, or with or without leading backslash ("\")
BA_AddLineLayer: Add a polyline shapefile to active view of a map document. Users can set the color of the line symbol.
BA_Raster2LineShapefile: Convert a raster to a polyline shapefile
BA_CompletedRuleCount: Returns number of IRules in a list that have FactorStatus of Complete
BA_CopyIntegerValuesFromGridToArray: Copies Integer values from DataGridView form control to an array of ReclassItem objects. Takes column indexes for the input and output value columns as arguments
BA_CopySlopeValuesFromGridToArray: Copies Double values from DataGridView form control to an array of ReclassItem objects. Takes column indexes for the from, to, and output value columns as arguments
BA_CopyTemplateItemsFromGridToArray: Copies Double, Integer, and String values from DataGridView form control to an array of ReclassItem objects. Takes column indexes for the from, to, description, and output value columns as arguments.
BA_CopyValuesFromGridToTable: Copies Double values from DataGridView form control to an ArcObjects ITable object and persists them
BA_CreateFolder: Creates a new folder when provided with root path and folder name using ArcObjects Workspace API
BA_CreateHru: Constructs and populates an HRU object; Saves statistics (feature count, avgSize, maxSize) in new HRU
BA_CreateHruOutputFolders: Builds up the Weasel folder structure for the hru output
BA_DeleteHRU: Deletes an HRU folder. Checks first to see if any layers in target HRU are in the current map document. If so, these layers are removed before the HRU is deleted
BA_FilterRaster: Applies filter to a raster and persists filtered raster
BA_GetHruPath: Assembles HRU file path string when provided with AOI and HRU names
BA_GetOutputFolderName: Generate the output folder name for hru input layer data; Abstraction layer because some output folders do not have the same name as the layer file name
BA_GetReclassRemap: Creates an INumberRemap object from an array of ReclassItems. Assumes the reclass items are sorted as mapRanges must be added to an INumberRemap object in order
BA_LayerInList: Interrogates a collection of LayerListItems from a ListBox form control to see if a given layer is in the ListBox
BA_LoadHRUFromXml: Populates an Aoi object, including any child HRU's, from an XML file
BA_MoveLayer: Moves a file from one folder to another. Checks first to see if the target file is in the current map document. If so, this layer is removed before the file is moved
BA_PrismMonthList: Extracts the list of prism months to add together from a PrismPrecipRule. Builds list of months to add together. Used for custom prism date ranges
BA_ProcessNonContiguousGrids: Adds contiguous/non-contiguous id columns to the hru vector. If contiguous hru only, remove the original hru grid and re-generate it from the hru vector using the HRUID_CO field as the grid value
BA_ReadSelectedZones: Converts a an IList of selected zones to an array of Zone objects
BA_ReadZonesFromRaster: Read the zones from an hru output grid to extract an array of Zone objects
BA_ReclassRasterFromRemap: Reclasses a raster using an INumberRemap object. Persists reclassed raster
BA_RuleFileName: Returns the file name for an HRU IRule file when provided with the full file path. Assumes the file name is 'grid'
BA_RunPrismPrecipRule: Sums selected prism rasters before slicing
BA_RunRule: Run HRU zone delineation IRule and persist output
BA_RunTemplateRule: Run HRU zone delineation IRule template and persist output
BA_SumRasterBands: Accepts a List of raster filepaths as input; Add the raster bands together and persist in the output path/file provided by the caller
BA_SortPendingRules: Reorder rule list when a rule is deleted. Rule file paths are dependent upon the order of the rules. If a completed rule's index changes during the sort process, the corresponding files will be moved. Checks first to see if any layers in target rule are in the current map document. If so, these layers are removed before the rule is moved
This module contains methods used when implementing a progress indicator. Methods will typically be called by event handlers on user forms.
BA_GetProgressDialog: Creates and configures an IProgressDialog2 object from an IStepProgressor
BA_GetStepProgressor: Creates and configures an IStepProgressor object
This module contains subroutines related generating a new set of hrus from a combination of selected parent hrus
BA_CookieCutterHru: Implements cookie cutter functionality
BA_CreateHruFromZones: Creates an hru raster from a collection of layers generated from a collection of iRules. The analysis area is limited to a selected set of zones from a parent hru dataset
BA_ReplaceNoDataCells: Generates a new raster replacing NoData cells with a selected value. The replacement extent may be masked if a mask file path is provided
BA_StampHru: Implements Stamp functionality
BA_CustomFishnet: Generates a fishnet shapefile. The extent and spatial reference are derived from a given shapefile. The cellsize is determined by the number of columns/rows
This module needs to be documented. It contains functions related to manipulating layers in a File Geodatabase
BA_ConvertShapeFileToGDB: Converts a shapefile to a feature class in a file geodatabase. Takes the source folder, source shapefile name, target geodatabase, and target feature class name as arguments. The original shapefile is not touched.