com.esri.arcgis.geodatabase
Interface IRouteEventProperties2

All Superinterfaces:

IRouteEventProperties, Serializable

All Known Implementing Classes:

RouteMeasureLineProperties, RouteMeasurePointProperties

public interface IRouteEventProperties2
extends IRouteEventProperties, Serializable

Provides access to the properties of an event table.

Remarks

The IRouteEventProperties2 interface provides additional event properties such as adding error field to the route event source (AddErrorField and ErrorFieldName), as well as the ability to specify whether the lateral offset is in the direction of the increasing measure direction or digitize direction (MDirectionOffseting).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getErrorFieldName() Name of the error field name.
boolean	isAddErrorField() Indicates if the error field should be added to the field set.
boolean	isMDirectionOffsetting() Indicates if the offset should based onthe M direction or the digitized direction.
void	setAddErrorField(boolean value) Indicates if the error field should be added to the field set.
void	setErrorFieldName(String fieldName) Name of the error field name.
void	setMDirectionOffsetting(boolean value) Indicates if the offset should based onthe M direction or the digitized direction.

Methods inherited from interface com.esri.arcgis.geodatabase.IRouteEventProperties

getEventMeasureUnit, getEventRouteIDFieldName, getLateralOffsetFieldName, getSettingError, isALineEvent, setEventMeasureUnit, setEventRouteIDFieldName, setLateralOffsetFieldName

Method Detail

setAddErrorField

void setAddErrorField(boolean value)
                      throws IOException,
                             AutomationException

Indicates if the error field should be added to the field set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddErrorField

boolean isAddErrorField()
                        throws IOException,
                               AutomationException

Indicates if the error field should be added to the field set.

Remarks

This property allows you to add a non editable and dynamic field to the route event source to provide information about whether the events were located or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorFieldName

void setErrorFieldName(String fieldName)
                       throws IOException,
                              AutomationException

Name of the error field name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorFieldName

String getErrorFieldName()
                         throws IOException,
                                AutomationException

Name of the error field name.

Remarks

If the AddErrorField property is set to True, this property is used to set the name of the field which will contain the locating errors.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMDirectionOffsetting

void setMDirectionOffsetting(boolean value)
                             throws IOException,
                                    AutomationException

Indicates if the offset should based onthe M direction or the digitized direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMDirectionOffsetting

boolean isMDirectionOffsetting()
                               throws IOException,
                                      AutomationException

Indicates if the offset should based onthe M direction or the digitized direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.