com.esri.arcgis.location
Interface IRouteMeasurePointProperties2

All Superinterfaces:

IRouteMeasurePointProperties, Serializable

All Known Implementing Classes:

RouteMeasurePointProperties

public interface IRouteMeasurePointProperties2
extends IRouteMeasurePointProperties, Serializable

Provides access to the route measure properties unique to point event tables.

Remarks

The IRouteMeasurePointProperties2 interface provides properties to add an angle field to the point RouteEventSource which can be used to cartographically rotate a point event marker.

Product Availability

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

Method Summary

String	getAngleFieldName() Name of the angle field name.
boolean	isAddAngleField() Indicates if an angle field should be added to the field set.
boolean	isAsPointFeature() Indicates if the point event shape should be output as a multipoint or a point.
boolean	isComplementAngle() Indicates if 180 degres should be added to the angle field value.
boolean	isNormalAngle() Indicates if the angle field should be the normal or the tangent anglea.
void	setAddAngleField(boolean angleField) Indicates if an angle field should be added to the field set.
void	setAngleFieldName(String fieldName) Name of the angle field name.
void	setAsPointFeature(boolean value) Indicates if the point event shape should be output as a multipoint or a point.
void	setComplementAngle(boolean value) Indicates if 180 degres should be added to the angle field value.
void	setNormalAngle(boolean value) Indicates if the angle field should be the normal or the tangent anglea.

Methods inherited from interface com.esri.arcgis.location.IRouteMeasurePointProperties

getMeasureFieldName, setMeasureFieldName

Method Detail

setAsPointFeature

void setAsPointFeature(boolean value)
                       throws IOException,
                              AutomationException

Indicates if the point event shape should be output as a multipoint or a point.

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.

isAsPointFeature

boolean isAsPointFeature()
                         throws IOException,
                                AutomationException

Indicates if the point event shape should be output as a multipoint or a point.

Remarks

If this property is set to True, the geometry of the RouteEventSource will be of type Point, and if this is False, the geometry will be of type Multipoint.

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.

setAddAngleField

void setAddAngleField(boolean angleField)
                      throws IOException,
                             AutomationException

Indicates if an angle 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:

angleField - The angleField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddAngleField

boolean isAddAngleField()
                        throws IOException,
                               AutomationException

Indicates if an angle field should be added to the field set.

Remarks

This property will allow you to add an angle field to the RouteEventSource. The angle is calculated dynamically for every point event at its route measure location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The angleField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngleFieldName

void setAngleFieldName(String fieldName)
                       throws IOException,
                              AutomationException

Name of the angle 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.

getAngleFieldName

String getAngleFieldName()
                         throws IOException,
                                AutomationException

Name of the angle field name.

Remarks

This is used to set the name of the angle field that will exist in the RouteEventSource.

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.

setNormalAngle

void setNormalAngle(boolean value)
                    throws IOException,
                           AutomationException

Indicates if the angle field should be the normal or the tangent anglea.

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.

isNormalAngle

boolean isNormalAngle()
                      throws IOException,
                             AutomationException

Indicates if the angle field should be the normal or the tangent anglea.

Remarks

This property is used to set whether the angle will be the normal angle (True) or the tangent angle (False) at the point event's route measure location. The normal angle is perpendicular to the route at the route measure location whereas, the tangent is parallel to the route.

The Normal direction is determined by what is set in IRouteEventProperties2::MDirectionOffsetting. If MDirectionOffsetting is set to True, the angle will be normal to the increasing measure direction. If MDirectionOffsetting is set to False, the angle will be normal to the route's 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.

setComplementAngle

void setComplementAngle(boolean value)
                        throws IOException,
                               AutomationException

Indicates if 180 degres should be added to the angle field value.

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.

isComplementAngle

boolean isComplementAngle()
                          throws IOException,
                                 AutomationException

Indicates if 180 degres should be added to the angle field value.

Remarks

The ComplementaryAngle property calculates the angle which is 180 degrees to the Normal or Tangent of the route at the point events route measure location. If the NormalAngle property is set to True, the calculated angle will be the angle 180 degrees to the Normal. If the NormalAngle property is set to False, the calculated angle will be the angle 180 degrees to the Tangent.

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.