Summary
Disables referent fields for an existing linear referencing system (LRS) event feature class or feature layer. It does not delete the referent columns; it removes the referent column information from the Lrs_Metadata table.
Usage
The referent fields must be enabled for the event prior to running this tool.
Syntax
arcpy.locref.DisableReferentFields(in_feature_class)
Parameter | Explanation | Data Type |
in_feature_class | The input feature class or feature layer for the LRS event. | Feature Layer |
Derived Output
Name | Explanation | Data Type |
out_feature_class | The updated feature layer for the event. | Feature Layer |
Code sample
The following script demonstrates how to use the DisableReferentFields tool in a Python window.
# Name: Disable_Referent_Fields_ex1.py
# Description: Disable referent fields in an existing LRS event feature class.
# Requires: ArcGIS Location Referencing
# Check out license
arcpy.CheckOutExtension("LocationReferencing")
# Set current workspace
arcpy.env.workspace = r"C:\db_connections\test_connection.sde"
# Local variables
in_feature_class = r"test_gdb.user.LRS.Event_FeatureClass"
# Execute the tool
arcpy.DisableReferentFields_locref(in_feature_class)
# Check in license
arcpy.CheckInExtension('LocationReferencing')
The following script demonstrates how to use the DisableReferentFields tool in a stand-alone Python script.
# Name: Disable_Referent_Fields_ex2.py
# Description: Disables referent fields in an existing LRS event feature class.
# Requires: ArcGIS Location Referencing
# import arcpy module
import arcpy
# Check out license
arcpy.CheckOutExtension("LocationReferencing")
# Local variables:
in_feature_class = r"C:\db_connections\test_connection.sde\LRS\test_gdb.user.Event_FeatureClass"
# Execute the tool
arcpy.DisableReferentFields_locref(in_feature_class)
# Check in license
arcpy.CheckInExtension('LocationReferencing')
Environments
This tool does not use any geoprocessing environments.
Licensing information
- Basic: Requires ArcGIS Location Referencing
- Standard: Requires ArcGIS Location Referencing
- Advanced: Requires ArcGIS Location Referencing