Summary
Lists changes that have been made to event record measures during a period of time. External systems can use this information at regular intervals to sync to route edits in the ArcGIS Roads and Highways network.
This tool can be invoked at intervals to sync your external system with the LRS changes.
Usage
This tool is intended to be published as a geoprocessing service for external event systems to periodically invoke. It will get measure changes to their events based on route edits in the Roads and Highways network.
Changing the geodatabase version of LRS Network layers in the map document before publishing the service may cause the service execution to fail.
The value provided for the Last Invoked Time parameter should be the date and time the external event system last invoked this web service and applied the returned event measure changes to its database. If no value is provided for this parameter, the event measure changes for all logged route edits in the LRS will be applied to the external events and returned in the response.
If the external event system does not support different geometry and measures for the same route across time (past or future), the LRS Time and Last LRS Time parameters must be set. Setting these parameters can ensure the tool does not return event measure changes that are effective in the future or past relative to the time view of the network that the external system supports. For example, if an external system only supports the current measures and geometry representation of a route, but the owners of the LRS have realigned a route effective in the system six months into the future, setting these time parameters can ensure the future event measure changes are not returned until the external system updates its route representations and stores them.
The LRS Time parameter tells Roads and Highways the time view of the LRS Network against which the external event system is measuring events. The Last LRS Time parameter tells Roads and Highways the LRS Time of the external system when it last invoked this web service and applied the returned event measure changes to its database. These two parameters ensure the event measure changes returned are appropriate to the time view of the LRS Network against which the external system is measuring events.
When you set LRS Time and Last LRS Time, along with Last Invoked Time, events will be relocated for all LRS edits that have occurred after the Last Invoked Time but only for those that are effective between the LRS Time and the Last LRS Time. It will also relocate events for LRS edits that occurred before the Last Invoked Time but are effective after the Last LRS Time.
This tool considers only LRS edits made using Roads and Highways version 10.2.2 or later.
The output dates are in epoch format.
Syntax
arcpy.locref.RelocateEvents(in_network, event_name, {last_invoked_time}, {lrs_time}, {last_lrs_time}, {output_format}, {export_file}, {out_features}, {include_event_geometry})| Parameter | Explanation | Data Type |
in_network | The LRS Network for which route edits will be inspected. | Feature Layer |
event_name | The LRS event layer to be relocated. The layer must be a registered external LRS event. An error will be returned if this event layer does not belong to the network you have chosen. | String |
last_invoked_time (Optional) | The last time this tool was executed. This value can be left empty or set to the Invoked Time output value from the previous execution of this tool. If you set this parameter, you will get events relocated for all LRS edits that have occurred after the Last Invoked Time. If you leave this value empty, you will get events relocated for all the LRS edits. | Date |
lrs_time (Optional) | The LRS view date for which route edits will be inspected. | Date |
last_lrs_time (Optional) | The LRS view date used for the previous execution of the tool. | Date |
output_format (Optional) | The data format of the output event records.
| String |
export_file (Optional) | Location and name of an output CSV or JSON file. This parameter is required when Output Format is CSV or JSON. | File |
out_features (Optional) | The feature class containing the output event records. This parameter is required when Output Format is FEATURE_CLASS. | Feature Class |
include_event_geometry (Optional) | Determines whether event shapes will be included with the output event records. This parameter is ignored unless output_format is JSON or FEATURE_CLASS.
| Boolean |
Derived Output
| Name | Explanation | Data Type |
| invoked_time | The database-specific time at which the tool is executed. This output can be used as the Last Invoked Time for the subsequent execution of this tool. | Date |
Code sample
RelocateEvents example 1 (Python window)
The following Python window script demonstrates how to use the RelocateEvents function in immediate mode.
# Local variables:
Network = "MilePoint"
External_Event_Name = "FunctionalClass_External"
Last_Invoked = "3/11/2014 10:00:00 AM"
LRS_Time = ""
Last_LRS_Time = ""
Output_Format = "FEATURE_CLASS"
Export_File = ""
Output = "C:\RoadsAndHighways\RelocateOutput.gdb\RelocateFunctionalClass"
Event_Geometry = "INCLUDE_EVENT_GEOMETRY"
# Process: Relocate Events
arcpy.RelocateEvents_locref(Network, External_Event_Name, Last_Invoked, LRS_Time, Last_LRS_Time, Output_Format, Export_File, Output, Event_Geometry)
RelocateEvents example 2 (stand-alone script)
The following Python script demonstrates how to use the RelocateEvents function in stand-alone mode.
# Import arcpy module
import arcpy
# Check out any necessary licenses
arcpy.CheckOutExtension("Highways")
# Local variables:
Network = "C:\RoadsAndHighways\Data\RH_DOT.gdb\LRSN_MilePoint"
External_Event_Name = "FunctionalClass_External"
Output_Format = "CSV"
Include_Event_Geometry = "false"
Output = "C:\RoadsAndHighways\RelocateOutput\RelocateFunctionalClass.csv"
# Process: Make Feature Layer
arcpy.MakeFeatureLayer_management(Network, "network_lyr")
# Process: Relocate Events
arcpy.RelocateEvents_locref("network_lyr", External_Event_Name, "", "", "", Output_Format, Output, "", Include_Event_Geometry)
Environments
This tool does not use any geoprocessing environments.
Licensing information
- Basic: Requires Roads and Highways
- Standard: Requires Roads and Highways
- Advanced: Requires Roads and Highways