Generate Could Affect Segments Report

Summary

Generate Could Affect Segments Report creates a simple report in PDF file format from the “could affect” segments linear events table you created with the Generate Could Affect Segments tool.

To learn more about the Liquids HCA Tool in general, please see Liquids HCA Tool Frequently Asked Questions.

To learn more about the structure of the Liquids HCA Tool project geodatabase, please see Liquids HCA Tool Project Database Data Dictionary.

Usage

The report output by Generate Could Affect Segments Report contains five distinct sections:

  • Report Title – This report section displays the report title, the name of your Liquids HCA project, and the date of the report.
  • Route Information – This report section displays information pertaining to the centerline route features in your Liquids HCA project geodatabase, including Route ID, Route Name, From Measure, To Measure, and Mileage.
  • Could Affect Definitions – This report section displays information about your “could affect” segment type definitions, including: Definition ID, HCA Type Description, and Intersection Method.
  • Summary – This report section displays “could affect” segment mileage summarized by centerline route and “could affect” segment type. Data columns displayed in this section include Route ID, (“could affect” segment type) Definition ID, HCA Type Description, Intersection Method, and Mileage.
  • Detailed Information – This report section displays a complete list of “could affect” segments sorted by centerline route, “could affect” segment type, and begin measure. Data columns displayed in this section include Route ID, (“could affect” segment type) Definition ID, From Measure, To Measure, and Mileage.

Generate Could Affect Segments Report uses the following parameters:

  • Input Project Database – This parameter allows you to specify the Liquids HCA project file geodatabase from which to generate your report. You created your project geodatabase with the Initialize Database By default, your input centerline route features and HCA could affect type definitions lookup table are both sourced from your Liquids HCA Project file geodatabase.
  • Input Centerline Route Features – This parameter allows you to specify the centerline route features upon which the “could affect” segments report is based. You import centerline route features into your Liquids HCA project geodatabase using the Initialize Database tool. The default value for this parameter is the ROUTES feature class in your Liquids HCA project geodatabase. The tool looks for this feature class automatically; there is generally no need to alter the default parameter value. Note that the input route features must include properly populated ROUTE_ID, ROUTE_DESC, FROM_MEAS, and TO_MEAS columns.
  • Input HCA “Could Affect Segments” Table – This parameter allows you to specify the “could affect” segments table upon which the “could affect” segments report is based. The default value for this parameter is the HCA_CA_SEGMENTS table in your Liquids HCA project geodatabase that you generated using the Generate Could Affect Segments tool. The tool looks for this table automatically; there is generally no need to alter the default parameter value.
  • Project Name – This parameter allows you to specify a project name to be used in the Report Title section of the output report.
  • Output “Could Affect” Segments Report (PDF) File – This parameter allows you to specify the destination for your output “could affect” segments report PDF file. The default destination is “HCA_CA_Report.pdf” located in the scratch folder of your current workspace.

In a typical Liquids HCA Tool analysis workflow, you run Generate Could Affect Segments Report after the Generate Could Affect Segments tool.

For visual reference on Liquids HCA Tool execution order, see Liquids HCA Tool Process Flow Diagrams.

Syntax

GenerateCouldAffectSegmentsReport (in_workspace, in_route_features, in_hca_ca_segments_table, project_name, out_pdf_file)

Parameter Explanation Data Type
in_workspace

Dialog Reference

Specify your input Liquids HCA Tool project geodatabase.

There is no Python reference for this parameter.

Workspace
in_route_features

Dialog Reference

Specify the input pipeline centerline route features from which to generate your “could affect” segments report.

There is no Python reference for this parameter.

Feature Layer
in_hca_ca_segments_table

Dialog Reference

Specify the input “could affect” segments table from which to generate your “could affect” segments report.

There is no Python reference for this parameter.

Table View
project_name

Dialog Reference

Specify a project name to include in the output “could affect” segments report PDF file.

There is no Python reference for this parameter.

String
out_pdf_file

Dialog Reference

Specify the destination of the output “could affect” segments report PDF file.

There is no Python reference for this parameter.

File

Code sample

The following script demonstrates how to use Generate Could Affect Segments Report in a Python window:

import arcpy
arcpy.ImportToolbox(r”C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\Lib\site-packages\liquidshca\esri\toolboxes\LiquidsHCA.pyt”)
in_workspace = r “C:\data\test.gdb”
route_features = r “C:\data\test.gdb\ROUTES”
hca_ca_seg_tbl = r “C:\data\test.gdb\HCA_CA_SEGMENTS”
pdf_file = “C:\data\hca_ca_seg.pdf”
proj_name = “Test Project”
arcpy.liquidshca.GenerateCouldAffectSegmentsReport(in_workspace, route_features, hca_ca_seg_tbl, proj_name, pdf_file)

Environments

Current Workspace, Scratch Workspace, Qualified Field Names, Output CONFIG Keyword, Auto Commit

Licensing information

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

Related topics

Tags

Liquids HCA, Centerline, Route, could affect segment.

Credits

Copyright © 2003-2021 by G2 Integrated Solutions, LLC. All Rights Reserved.

Use limitations

There are no access and use limitations for this item.