Prepare Structures

Summary

Prepare Structures copies your point or polygon Buildings Intended for Human Occupancy (BIHO) features from your pipeline database into your Gas HCA Tool project geodatabase for use in Class Location and HCA-MCA analysis.

Usage

  • The tool populates (by default) the following features classes in your Gas HCA Tool project geodatabase:
      • STRUCTURE_POINT – When your input features are points.
      • STRUCTURE_POLYGON – When your input features are polygons.
  • Without a feature selection or a feature layer definition query, Prepare Structures copies all input features. When using a feature layer as input, you may want to apply an appropriate definition query or feature selection to ensure that only the features needed for Class Location or HCA-MCA analysis are copied into your Gas HCA Tool project geodatabase.
  • Input Structure Features – This parameter allows you to select multiple input layers or feature classes, and to mix point and polygon shape types in the input feature layers or feature classes. However, all input layers/feature classes must have a common schema.
  • Number of Dwelling Units Field – This parameter indicates the number of dwelling units present in the BIHO feature. For a single-family residence, the number is 1. For an apartment structure, the number is the number of apartment units in the feature.
  • Number of Stories Field – This field contains the number of stories in the BIHO feature. This field is used in the determination of Class 4 ranges in Class Location analysis. This field is not used in HCA-MCA analysis.
  • Output Structure Point Features and Output Structure Polygon Features – These parameters are optional; unless otherwise specified the default to the above standard output feature classes in your Gas HCA Tool project geodatabase.
  • Prepare Structures (together with Prepare Qualifying Areas) is generally run after Prepare Centerline Buffers and before Prepare Structure and Site Buffers and Segments in a typical Class Location analysis workflow. In a typical HCA-MCA analysis workflow, Prepare Structures (together with Prepare Qualifying Areas) is generally run after Copy Centerlines and before Prepare Pipe Segment and MAOP Features.

Syntax

PrepareStructureTool_hcapy (project_database, input_structure, structure_id_field, number_of_units, number_of_stories, struct_buffer_distance_value, {discover_date}, {structure_date}, {output_structure_point}, {output_structure_polygon})

Parameter Explanation Data Type
project_database

Dialog Reference

Select a Gas HCA Tool project geodatabase created using the Initialize Database tool. The output from this tool is stored in this workspace.

There is no Python reference for this parameter.

Workspace
input_structure

Dialog Reference

Specify your input BIHO features. You may select multiple point and polygon feature layers or feature classes.

There is no Python reference for this parameter.

Multiple Value
structure_id_field

Dialog Reference

Specify the field that uniquely identifies each BIHO feature.

There is no Python reference for this parameter.

String
number_of_units

Dialog Reference

Specify the field that defines the number of dwelling units in each BIHO feature.

There is no Python reference for this parameter.

String
number_of_stories

Dialog Reference

Specify the field that defines the number of stories in each BIHO feature.

There is no Python reference for this parameter.

String
struct_buffer_distance_value

Dialog Reference

Specify the desired BIHO buffer selection distance value and linear units of measure. The default value is 660 feet.

There is no Python reference for this parameter.

Linear Unit

discover_date

(Optional)

Dialog Reference

Specify the field that records the “discovery date” of your BIHO features.

There is no Python reference for this parameter.

String

structure_date

(Optional)

Dialog Reference

Specify the field that records the date at which your BIHO features were added to your pipeline database.

There is no Python reference for this parameter.

String

output_structure_point

(Optional)

Dialog Reference

Specify the destination of the output point BIHO features.

There is no Python reference for this parameter.

Feature Layer

output_structure_polygon

(Optional)

Dialog Reference

Specify the destination of the output polygon BIHO features.

There is no Python reference for this parameter.

Feature Layer

Code sample

Prepare Structures

# Import GasHCA Library
import hcapy
# improt Gas HCA Tools
arcpy.ImportToolbox(“C:\Python27\ArcGIS10.6\Lib\site-packages\hcapy\esri\Toolboxes\Gas HCA Tools.pyt”)
project_database = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test5.gdb”
input_structure = r”C:\projects\GasHCA_Enhancements\Test.gdb\structure_BIHO”
structure_id_field = “StructorSiteID”
number_of_units = “Num_Units”
number_of_stories = “Num_Stories”
struct_buffer_distance_value = “660 Feet”
# Execute tool
arcpy.PrepareStructure_hcapy(project_database, input_structure, structure_id_field, number_of_units, number_of_stories, struct_buffer_distance_value)

Environments

Current Workspace, Scratch Workspace, Default Output Z Value, M Resolution, M Tolerance, Output M Domain, Output XY Domain, Output Z Domain, Output Coordinate System, Extent, Geographic Transformations, Output has M values, Output has Z values, XY Resolution, XY Tolerance, Z Resolution, Z Tolerance

Licensing information

This tool requires a valid Gas HCA Tool user license or subscription. Please see the Request License and Register License tool help topics for details on obtaining and registering a Gas HCA Tool software license.

Related topics

Tags

Building Intended for Human Occupancy, BIHO, Class Location, HCA, MCA.

Credits

Copyright © 2016-2020 by G2 Integrated Solutions, LLC. All Rights Reserved.

Use limitations

There are no access and use limitations for this item.