Enable Referent Fields (Location Referencing)

摘要

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

Learn more about event referent fields

使用情况

  • The tool enables the referent fields by allowing you to register the existing fields as the referent fields.

  • If referent fields are already enabled, then by default, the tool will populate the existing fields 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.

参数

标注说明数据类型
Event Feature Class

The feature class that will be used for the LRS event.

Feature Layer
Referent Method Field
(可选)

The From referent method field.

Field
Referent Location Field
(可选)

The From referent location field.

Field
Referent Offset Field
(可选)

The From referent offset field.

Field
To Referent Method Field
(可选)

The To referent method field.

Field
To Referent Location Field
(可选)

The To referent location field.

Field
To Referent Offset Field
(可选)

The To referent offset field.

Field
Offset Units
(可选)

Specifies the offset units to be used. The default is feet.

  • CentimetersCentimeters is the offset unit.
  • DecimetersDecimeters is the offset unit.
  • FeetFeet is the offset unit.
  • InchesInches is the offset unit.
  • KilometersKilometers is the offset unit.
  • MetersMeters is the offset unit.
  • MilesMiles is the offset unit.
  • MillimetersMillimeters is the offset unit.
  • YardsYards is the offset unit.
String

派生输出

标注说明数据类型
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})
名称说明数据类型
in_feature_class

The feature class that will be used for the LRS event.

Feature Layer
from_referent_method_field
(可选)

The From referent method field.

Field
from_referent_location_field
(可选)

The From referent location field.

Field
from_referent_offset_field
(可选)

The From referent offset field.

Field
to_referent_method_field
(可选)

The To referent method field.

Field
to_referent_location_field
(可选)

The To referent location field.

Field
to_referent_offset_field
(可选)

The To referent offset field.

Field
offset_units
(可选)

Specifies the offset units to be used. The default is feet.

  • CENTIMETERSCentimeters is the offset unit.
  • DECIMETERSDecimeters is the offset unit.
  • FEETFeet is the offset unit.
  • INCHESInches is the offset unit.
  • KILOMETERSKilometers is the offset unit.
  • METERSMeters is the offset unit.
  • MILESMiles is the offset unit.
  • MILLIMETERSMillimeters is the offset unit.
  • YARDSYards is the offset unit.
String

派生输出

名称说明数据类型
out_feature_class

The updated event feature layer.

Feature Layer

代码示例

EnableReferentFields example 1 (Python window)

The following Python window script demonstrates how to use the EnableReferentFields tool 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

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

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

# Execute the tool
arcpy.EnableReferentFields_locref(inputEventFC, fromReferentMethodField, fromReferentLocationField,
                                  fromReferentOffsetField, toReferentMethodField, toReferentLocationField,
                                  toReferentOffsetField, offsetUnit)

# Check in license
arcpy.CheckInExtension('LocationReferencing')
EnableReferentFields example 2 (stand-alone script)

The following stand-alone Python script demonstrates how to use the EnableReferentFields tool 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

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

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

# execute the tool
arcpy.EnableReferentFields_locref(inputEventFC, fromReferentMethodField, fromReferentLocationField,
                                  fromReferentOffsetField, toReferentMethodField, toReferentLocationField,
                                  toReferentOffsetField, offsetUnit)

# Check in license
arcpy.CheckInExtension('LocationReferencing')
EnableReferentFields example 3 (stand-alone script)

The following stand-alone Python script demonstrates how to use the EnableReferentFields tool to modify referent fields for an existing LRS event that already has 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

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

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

# Execute the tool
arcpy.EnableReferentFields_locref(inputEventFC, '' , '' , '' , toReferentMethodField, toReferentLocationField, toReferentOffsetField)

# Check in license
arcpy.CheckInExtension('LocationReferencing')

环境

此工具不使用任何地理处理环境。

许可信息

  • Basic: 需要 ArcGIS Location Referencing
  • Standard: 需要 ArcGIS Location Referencing
  • Advanced: 需要 ArcGIS Location Referencing

相关主题