Back to Top

Modify Event Behavior Rules (Location Referencing)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Summary

Modifies event behavior rules for the registered event layer or feature class.

Usage

  • The following event behavior rules are set by default:

    ActivityRule

    Calibrate Route

    Stay Put

    Retire Route

    Stay Put

    Extend Route

    Stay Put

    Reassign Route

    Stay Put

    Realign Route

    Stay Put

    Reverse Route

    Stay Put

    Carto Realign Route

    Honor Route Measure

Parameters

DialogPython

LabelExplanationData Type
Event Feature Class

The event feature class.

Feature Layer
Calibrate Rule
(Optional)

Specifies the event behavior rule that will be defined for the calibrate activity.

  • Stay put—The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire—Both measure and geographic location will be preserved; the event will be retired.
  • Move—The measures of the event will be preserved; the geographic location may change.
String
Retire Rule
(Optional)

Specifies the event behavior rule that will be defined for the retire activity.

  • Stay put—The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire—Both measure and geographic location will be preserved; the event will be retired.
  • Move—The measures of the event will be preserved; the geographic location may change.
String
Extend Rule
(Optional)

Specifies the event behavior rule that will be defined for the extend activity.

  • Stay put—The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire—Both measure and geographic location will be preserved; the event will be retired.
  • Move—The measures of the event will be preserved; the geographic location may change.
  • Cover—The geometric location and measure of a line event will be modified to include a new or newly modified section.
String
Reassign Rule
(Optional)

Specifies the event behavior rule that will be defined for the reassign activity.

  • Stay put—The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire—Both measure and geographic location will be preserved; the event will be retired.
  • Move—The measures of the event will be preserved; the geographic location may change.
  • Snap—The geographic location of an event will be preserved by snapping the event to a concurrent route; measures may change.
String
Realign Rule
(Optional)

Specifies the event behavior rule that will be defined for the realign activity.

  • Stay put—The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire—Both measure and geographic location will be preserved; the event will be retired.
  • Move—The measures of the event will be preserved; the geographic location may change.
  • Snap—The geographic location of an event will be preserved by snapping the event to a concurrent route; measures may change.
  • Cover—The geometric location and measure of a line event will be modified to include a new or newly modified section.
String
Reverse Rule
(Optional)

Specifies the event behavior rule that will be defined for the reverse activity.

  • Stay put— The geographic location of the event will be preserved; measures may change. This is the default.
  • Retire— Both measure and geographic location will be preserved; the event will be retired.
  • Move— The measures of the event will be preserved; the geographic location may change.
String
Carto Realign Rule
(Optional)

Specifies the event behavior rule that will be defined for the cartographic realignment activity.

  • Honor Route Measure—The measure of the event will be preserved or will change proportionally to the route's measure change. This is the default.
  • Honor Referent Location—The referent location of the event will be preserved.
String

Derived Output

LabelExplanationData Type
Updated Input Feature Class

The updated feature layer.

Feature Layer

arcpy.locref.ModifyEventBehaviorRules(in_feature_class, {calibrate_rule}, {retire_rule}, {extend_rule}, {reassign_rule}, {realign_rule}, {reverse_rule}, {carto_realign_rule})
NameExplanationData Type
in_feature_class

The event feature class.

Feature Layer
calibrate_rule
(Optional)

Specifies the event behavior rule that will be defined for the calibrate activity.

  • STAY_PUT—The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE—Both measure and geographic location will be preserved; the event will be retired.
  • MOVE—The measures of the event will be preserved; the geographic location may change.
String
retire_rule
(Optional)

Specifies the event behavior rule that will be defined for the retire activity.

  • STAY_PUT—The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE—Both measure and geographic location will be preserved; the event will be retired.
  • MOVE—The measures of the event will be preserved; the geographic location may change.
String
extend_rule
(Optional)

Specifies the event behavior rule that will be defined for the extend activity.

  • STAY_PUT—The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE—Both measure and geographic location will be preserved; the event will be retired.
  • MOVE—The measures of the event will be preserved; the geographic location may change.
  • COVER—The geometric location and measure of a line event will be modified to include a new or newly modified section.
String
reassign_rule
(Optional)

Specifies the event behavior rule that will be defined for the reassign activity.

  • STAY_PUT—The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE—Both measure and geographic location will be preserved; the event will be retired.
  • MOVE—The measures of the event will be preserved; the geographic location may change.
  • SNAP—The geographic location of an event will be preserved by snapping the event to a concurrent route; measures may change.
String
realign_rule
(Optional)

Specifies the event behavior rule that will be defined for the realign activity.

  • STAY_PUT—The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE—Both measure and geographic location will be preserved; the event will be retired.
  • MOVE—The measures of the event will be preserved; the geographic location may change.
  • SNAP—The geographic location of an event will be preserved by snapping the event to a concurrent route; measures may change.
  • COVER—The geometric location and measure of a line event will be modified to include a new or newly modified section.
String
reverse_rule
(Optional)

Specifies the event behavior rule that will be defined for the reverse activity.

  • STAY_PUT— The geographic location of the event will be preserved; measures may change. This is the default.
  • RETIRE— Both measure and geographic location will be preserved; the event will be retired.
  • MOVE— The measures of the event will be preserved; the geographic location may change.
String
carto_realign_rule
(Optional)

Specifies the event behavior rule that will be defined for the cartographic realignment activity.

  • HONOR_ROUTE_MEASURE—The measure of the event will be preserved or will change proportionally to the route's measure change. This is the default.
  • HONOR_REFERENT_LOCATION—The referent location of the event will be preserved.
String

Derived Output

NameExplanationData Type
out_feature_class

The updated feature layer.

Feature Layer

Code sample

ModifyEventBehaviorRules example 1 (Python window)

The following script demonstrates how to use the ModifyEventBehaviorRules function in a Python window.

# Name: Modify_Event_Behavior_Rules_ex1.py
# Description: Modify event behavior rules for the registered event layer or feature class.
# Requires: ArcGIS Location Referencing 

# Local tool variables 
in_feature_class = r"Data.gdb\LRS\P_ILIInspectionRange"
calibrate_rule = "RETIRE"
retire_rule = "STAY_PUT"
extend_rule = "STAY_PUT"
reassign_rule = "STAY_PUT"
realign_rule = "STAY_PUT"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\Data.gdb"

# Execute the tool
arcpy.locref.ModifyEventBehaviorRules(in_feature_class, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)
ModifyEventBehaviorRules example 2 (stand-alone script)

The following script demonstrates how to use the ModifyEventBehaviorRules function in a stand-alone Python script.

# Name: Modify_Event_Behavior_Rules_ex2.py
# Description: Modify event behavior rules for the registered event layer or feature class
# Requires: ArcGIS Location Referencing 

# Import arcpy module
import arcpy 

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

# Local tool variables 
in_feature_class = r"Data.gdb\LRS\P_ILIInspectionRange"
calibrate_rule = "RETIRE"
retire_rule = "STAY_PUT"
extend_rule = "STAY_PUT"
reassign_rule = "STAY_PUT"
realign_rule = "STAY_PUT"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Execute the tool
arcpy.locref.ModifyEventBehaviorRules(in_feature_class, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)

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

Environments

Current Workspace

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)

Related topics

  • An overview of the LRS Event toolset
  • Find a geoprocessing tool

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information