Modify Event Behavior Rules (Location Referencing)

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

    Realign Route

    Stay Put

    Reassign Route

    Stay Put

    Carto Realign Route

    Honor Route Measure

Syntax

ModifyEventBehaviorRules(in_feature_class, {calibrate_rule}, {retire_rule}, {extend_rule}, {reassign_rule}, {realign_rule})
ParameterExplanationData Type
in_feature_class

The event feature class.

Feature Layer
calibrate_rule
(Optional)

Specifies the event behavior rule defined for the calibrate activity.

  • STAY_PUTThe geographic location of the event is preserved; measures may change. This is the default.
  • RETIREBoth measure and geographic location are preserved; the event is retired.
  • MOVEThe measures of the event are preserved; the geographic location may change.
String
retire_rule
(Optional)

Specifies the event behavior rule defined for the retire activity.

  • STAY_PUTThe geographic location of the event is preserved; measures may change. This is the default.
  • RETIREBoth measure and geographic location are preserved; the event is retired.
  • MOVEThe measures of the event are preserved; the geographic location may change.
String
extend_rule
(Optional)

Specifies the event behavior rule defined for the extend activity.

  • STAY_PUTThe geographic location of the event is preserved; measures may change. This is the default.
  • RETIREBoth measure and geographic location are preserved; the event is retired.
  • MOVEThe measures of the event are preserved; the geographic location may change.
String
reassign_rule
(Optional)

Specifies the event behavior rule defined for the reassign activity.

  • STAY_PUTThe geographic location of the event is preserved; measures may change. This is the default.
  • RETIREBoth measure and geographic location are preserved; the event is retired.
  • MOVEThe measures of the event are preserved; the geographic location may change.
  • SNAPThe geographic location of an event is preserved by snapping the event to a concurrent route; measures may change.
String
realign_rule
(Optional)

Specifies the event behavior rule defined for the realign activity.

  • STAY_PUTThe geographic location of the event is preserved; measures may change. This is the default.
  • RETIREBoth measure and geographic location are preserved; the event is retired.
  • MOVEThe measures of the event are preserved; the geographic location may change.
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 tool 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 

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

# 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"

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

# Execute the tool
arcpy.ModifyEventBehaviorRules_locref(in_feature_class, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule)

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

The following script demonstrates how to use the ModifyEventBehaviorRules tool 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 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"

# Process:  Modify Event Behavior Rules
arcpy.ModifyEventBehaviorRules_locref(in_feature_class, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule)

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

Environments

Licensing information

  • Basic: Requires ArcGIS Location Referencing
  • Standard: Requires ArcGIS Location Referencing
  • Advanced: Requires ArcGIS Location Referencing

Related topics