Enable Referent Fields (Location Referencing Tools)

Summary

Enables or modifies the referent fields so that you can manage referent information for the registered LRS event.

Usage

The tool enables the referent fields by allowing you to register the existing fields as the referent fields.
If referent fields are already enabled, the tool will populate the existing fields by default so that they can be modified.
The existing data in the referent fields is not validated or updated when you enable or modify the referent fields.
To disable the referent fields, use the Disable Referent Fields tool.

Label	Explanation	Data type
Event Feature Class	The feature class that will be used for the LRS event.	Feature Layer
Referent Method Field (Optional)	The From referent method field.	Field
Referent Location Field (Optional)	The From referent location field.	Field
Referent Offset Field (Optional)	The From referent offset field.	Field
To Referent Method Field (Optional)	The To referent method field.	Field
To Referent Location Field (Optional)	The To referent location field.	Field
To Referent Offset Field (Optional)	The To referent offset field.	Field
Offset Units (Optional)	Specifies the offset unit of measure that will be used. Miles (US Survey)—The unit of measure will be miles. This is the default. Inches (US Survey)—The unit of measure will be inches. Feet (US Survey)—The unit of measure will be feet. Yards (US Survey)—The unit of measure will be yards. Nautical Miles (US Survey)—The unit of measure will be nautical miles. Feet (International)—The unit of measure will be international feet. Statute Miles—The unit of measure will be statute miles. Millimeters—The unit of measure will be millimeters. Centimeters—The unit of measure will be centimeters. Meters—The unit of measure will be meters. Kilometers—The unit of measure will be kilometers. Decimeters—The unit of measure will be decimeters.	String

Derived output

Label	Explanation	Data type
Output Event Feature Class	The updated event feature layer.	Feature Layer

arcpy.locref.EnableReferentFields(in_feature_class, {from_referent_method_field}, {from_referent_location_field}, {from_referent_offset_field}, {to_referent_method_field}, {to_referent_location_field}, {to_referent_offset_field}, {offset_units})

Name	Explanation	Data type
in_feature_class	The feature class that will be used for the LRS event.	Feature Layer
from_referent_method_field (Optional)	The From referent method field.	Field
from_referent_location_field (Optional)	The From referent location field.	Field
from_referent_offset_field (Optional)	The From referent offset field.	Field
to_referent_method_field (Optional)	The To referent method field.	Field
to_referent_location_field (Optional)	The To referent location field.	Field
to_referent_offset_field (Optional)	The To referent offset field.	Field
offset_units (Optional)	Specifies the offset unit of measure that will be used. `MILES`—The unit of measure will be miles. This is the default. `INCHES`—The unit of measure will be inches. `FEET`—The unit of measure will be feet. `YARDS`—The unit of measure will be yards. `NAUTICAL_MILES`—The unit of measure will be nautical miles. `INTFEET`—The unit of measure will be international feet. `INTMILES`—The unit of measure will be statute miles. `MILLIMETERS`—The unit of measure will be millimeters. `CENTIMETERS`—The unit of measure will be centimeters. `METERS`—The unit of measure will be meters. `KILOMETERS`—The unit of measure will be kilometers. `DECIMETERS`—The unit of measure will be decimeters.	String

Derived output

Name	Explanation	Data type
out_feature_class	The updated event feature layer.	Feature Layer

Code sample

EnableReferentFields example 1 (Python window)

The following Python script demonstrates how to use the EnableReferentFields function in immediate mode to enable referent fields for an existing LRS event.

# Name: Enable_Referent_Fields_ex1.py
# Description: Enable referent fields for an existing LRS Event that already has referent fields configured.
# Requires: ArcGIS Location Referencing

# Local variables:
inputEventFC = r"C:\EnableReferent\Py\EnableReferent.gdb\LRS\Event_Feature_Class"
fromReferentMethodField = "FromRefMethod"
fromReferentLocationField = "FromRefLocation"
fromReferentOffsetField = "FromRefOffset"
toReferentMethodField = "ToRefMethod"
toReferentLocationField = "ToRefLocation"
toReferentOffsetField = "ToRefOffset"
offsetUnit = "FEET"

# Run the tool
arcpy.locref.EnableReferentFields(inputEventFC, fromReferentMethodField, fromReferentLocationField,
                                  fromReferentOffsetField, toReferentMethodField, toReferentLocationField,
                                  toReferentOffsetField, offsetUnit)

EnableReferentFields example 2 (stand-alone script)

The following stand-alone Python script demonstrates how to use the EnableReferentFields function to enable referent fields for an existing LRS event.

# Name: Enable_Referent_Fields_ex2.py
# Description: Enables referent fields for an existing LRS Event.
# Requires: ArcGIS Pipeline Referencing

# Import arcpy module
import arcpy

# Local variables
inputEventFC = r"C:\EnableReferent\Py\EnableReferent.gdb\LRS\Event_Feature_Class"
fromReferentMethodField = "FromRefMethod"
fromReferentLocationField = "FromRefLocation"
fromReferentOffsetField = "FromRefOffset"
toReferentMethodField = "ToRefMethod"
toReferentLocationField = "ToRefLocation"
toReferentOffsetField = "ToRefOffset"
offsetUnit = "FEET"

# Run the tool
arcpy.locref.EnableReferentFields(inputEventFC, fromReferentMethodField, fromReferentLocationField,
                                  fromReferentOffsetField, toReferentMethodField, toReferentLocationField,
                                  toReferentOffsetField, offsetUnit)

EnableReferentFields example 3 (stand-alone script)

The following stand-alone Python script demonstrates how to use the EnableReferentFields function to modify referent fields for an existing LRS event that includes configured referent fields.

# Name: Enable_Referent_Fields_ex3.py
# Description: Modifies  referent fields for an existing LRS Event that already has referent fields configured.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy

# Local variables:
inputEventFC = r"C:\EnableReferent\Py\EnableReferent.gdb\LRS\Event_Feature_Class"
toReferentMethodField = "ToRefMethod2"
toReferentLocationField = "ToRefLocation2"
toReferentOffsetField = "ToRefOffset2"

# Run the tool
arcpy.locref.EnableReferentFields(inputEventFC, '', '', '', toReferentMethodField, toReferentLocationField, toReferentOffsetField, '')

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
Standard: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
Advanced: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)

Enable Referent Fields (Location Referencing Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics