com.esri.arcgis.location
Class RouteMeasureLineLocation

java.lang.Object
  com.esri.arcgis.location.RouteMeasureLineLocation

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IRouteLocation, IRouteLocation2, IRouteMeasureLineLocation, ISupportErrorInfo, Serializable

public class RouteMeasureLineLocation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteLocation2, IRouteMeasureLineLocation, ISupportErrorInfo

A route measure line location.

Remarks

A RouteMeasureLineLocation uses from and to measure values to describe a portion of a route.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteMeasureLineLocation()
Constructs a RouteMeasureLineLocation using ArcGIS Engine.

RouteMeasureLineLocation(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureLineLocation theRouteMeasureLineLocation = (RouteMeasureLineLocation) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
double	getFromMeasure() The 'from' measure value.
double	getLateralOffset() The route location's lateral offset (default 0.0).
int	getMeasureUnit() The route location's measure units.
Object	getRouteID() The route identifier (string, integer or double).
double	getToMeasure() The 'to' measure value.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isMDirectionOffsetting() Indicates if the offset should based on the M direction or the digitized direction.
void	setFromMeasure(double value) The 'from' measure value.
void	setLateralOffset(double value) The route location's lateral offset (default 0.0).
void	setMDirectionOffsetting(boolean value) Indicates if the offset should based on the M direction or the digitized direction.
void	setMeasureUnit(int units) The route location's measure units.
void	setRouteID(Object rid) The route identifier (string, integer or double).
void	setToMeasure(double value) The 'to' measure value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RouteMeasureLineLocation

public RouteMeasureLineLocation()
                         throws IOException,
                                UnknownHostException

Constructs a RouteMeasureLineLocation using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteMeasureLineLocation

public RouteMeasureLineLocation(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureLineLocation theRouteMeasureLineLocation = (RouteMeasureLineLocation) obj;

Construct a RouteMeasureLineLocation using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RouteMeasureLineLocation.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setMDirectionOffsetting

public void setMDirectionOffsetting(boolean value)
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMDirectionOffsetting in interface IRouteLocation2

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMDirectionOffsetting

public boolean isMDirectionOffsetting()
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMDirectionOffsetting in interface IRouteLocation2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteID

public void setRouteID(Object rid)
                throws IOException,
                       AutomationException

The route identifier (string, integer or double).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteID in interface IRouteLocation

Parameters:

rid - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteID

public Object getRouteID()
                  throws IOException,
                         AutomationException

The route identifier (string, integer or double).

Remarks

The RouteID property defines the route identifier on which the route measure location exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteID in interface IRouteLocation

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasureUnit

public void setMeasureUnit(int units)
                    throws IOException,
                           AutomationException

The route location's measure units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMeasureUnit in interface IRouteLocation

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

public int getMeasureUnit()
                   throws IOException,
                          AutomationException

The route location's measure units.

Remarks

The MeasureUnit property is the unit of measurement for the route measure location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMeasureUnit in interface IRouteLocation

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLateralOffset

public void setLateralOffset(double value)
                      throws IOException,
                             AutomationException

The route location's lateral offset (default 0.0).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLateralOffset in interface IRouteLocation

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLateralOffset

public double getLateralOffset()
                        throws IOException,
                               AutomationException

The route location's lateral offset (default 0.0).

Remarks

The LateralOffset property is the lateral offset of the route measure location from the route. Whether this offset is to the left or right of the route depends IRouteLocation2::MDirectionOffsetting property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLateralOffset in interface IRouteLocation

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromMeasure

public void setFromMeasure(double value)
                    throws IOException,
                           AutomationException

The 'from' measure value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFromMeasure in interface IRouteMeasureLineLocation

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromMeasure

public double getFromMeasure()
                      throws IOException,
                             AutomationException

The 'from' measure value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFromMeasure in interface IRouteMeasureLineLocation

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToMeasure

public void setToMeasure(double value)
                  throws IOException,
                         AutomationException

The 'to' measure value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setToMeasure in interface IRouteMeasureLineLocation

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToMeasure

public double getToMeasure()
                    throws IOException,
                           AutomationException

The 'to' measure value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getToMeasure in interface IRouteMeasureLineLocation

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.