com.esri.arcgis.datasourcesfile
Class ISMTripPlanSettingsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesfile.ISMTripPlanSettingsProxy

All Implemented Interfaces:

ISMTripPlanSettings, Externalizable, Serializable

public class ISMTripPlanSettingsProxy
extends com.esri.arcgis.interop.Dispatch
implements ISMTripPlanSettings, Serializable

Deprecated as of 10.1. Provides access to the trip planning settings.

Description

Trip planning settings interface for controlling time intervals for driving, for rest, stop durations, and so on.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISMTripPlanSettingsProxy()
	ISMTripPlanSettingsProxy(Object obj)
protected	ISMTripPlanSettingsProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
Date	getDayDriveEnd() Time from midnight when driving must stop every day.
Date	getDayDriveStart() Time from midnight when driving must start every day.
short	getDriveBetweenRest() Driving time between rest breaks in minutes.
short	getDriveFlexibility() Amount of driving time allowed after the DayDriveEnd time is reached.
short	getRestDuration() The duration of rest breaks in minutes.
Date	getTripStart() The start date of the trip.
boolean	isRestBreaksEnable() Indicates whether periodic rest breaks are enabled.
boolean	isTripPlanningEnable() Indicates whether trip planning is enabled.
void	removeListener(String iidStr, Object theListener)
void	setDayDriveEnd(Date pVal) Time from midnight when driving must stop every day.
void	setDayDriveStart(Date pVal) Time from midnight when driving must start every day.
void	setDriveBetweenRest(short pVal) Driving time between rest breaks in minutes.
void	setDriveFlexibility(short pVal) Amount of driving time allowed after the DayDriveEnd time is reached.
void	setRestBreaksEnable(boolean pVal) Indicates whether periodic rest breaks are enabled.
void	setRestDuration(short pVal) The duration of rest breaks in minutes.
void	setTripPlanningEnable(boolean pVal) Indicates whether trip planning is enabled.
void	setTripStart(Date pVal) The start date of the trip.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISMTripPlanSettingsProxy

public ISMTripPlanSettingsProxy()

ISMTripPlanSettingsProxy

public ISMTripPlanSettingsProxy(Object obj)
                         throws IOException

Throws:

IOException

ISMTripPlanSettingsProxy

protected ISMTripPlanSettingsProxy(Object obj,
                                   String iid)
                            throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

isTripPlanningEnable

public boolean isTripPlanningEnable()
                             throws IOException,
                                    AutomationException

Indicates whether trip planning is enabled.

Description

Reads the value which enables trip planning during the route finding.

Remarks

If TripPlanningEnable is set to True then router finds the route and generates directions using all settings made in ISMTripPlanSettings interface. Otherwise no trip planning is performed.

Product Availability

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

Specified by:

isTripPlanningEnable in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripPlanningEnable

public void setTripPlanningEnable(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates whether trip planning is enabled.

Description

Sets the enabled value of the trip planning during the route finding.

Remarks

If TripPlanningEnable is set to True then router finds the route and generates directions using all settings made in ISMTripPlanSettings interface. Otherwise no trip planning is performed.

Product Availability

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

Specified by:

setTripPlanningEnable in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTripStart

public Date getTripStart()
                  throws IOException,
                         AutomationException

The start date of the trip.

Description

Returns the departure time for the first day of travel.

Product Availability

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

Specified by:

getTripStart in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripStart

public void setTripStart(Date pVal)
                  throws IOException,
                         AutomationException

The start date of the trip.

Description

Sets the departure time for the first day of travel.

Product Availability

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

Specified by:

setTripStart in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveStart

public Date getDayDriveStart()
                      throws IOException,
                             AutomationException

Time from midnight when driving must start every day.

Description

Returns the departure time starting with day two.

Product Availability

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

Specified by:

getDayDriveStart in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveStart

public void setDayDriveStart(Date pVal)
                      throws IOException,
                             AutomationException

Time from midnight when driving must start every day.

Description

Sets the departure time starting with day two.

Product Availability

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

Specified by:

setDayDriveStart in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveEnd

public Date getDayDriveEnd()
                    throws IOException,
                           AutomationException

Time from midnight when driving must stop every day.

Description

Returns the time when driving must end everyday.

Product Availability

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

Specified by:

getDayDriveEnd in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveEnd

public void setDayDriveEnd(Date pVal)
                    throws IOException,
                           AutomationException

Time from midnight when driving must stop every day.

Description

Sets the time when driving must end everyday.

Product Availability

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

Specified by:

setDayDriveEnd in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveFlexibility

public short getDriveFlexibility()
                          throws IOException,
                                 AutomationException

Amount of driving time allowed after the DayDriveEnd time is reached.

Description

Returns the time (in minutes) that driving is allowed after the Drive End Time.

Remarks

DriveFlexibility sets an additional time interval (in minutes) after drive day end that may be spent to reach the stop.

Product Availability

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

Specified by:

getDriveFlexibility in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveFlexibility

public void setDriveFlexibility(short pVal)
                         throws IOException,
                                AutomationException

Amount of driving time allowed after the DayDriveEnd time is reached.

Description

Sets the time (in minutes) that driving is allowed after the Drive End Time.

Remarks

DriveFlexibility sets an additional time interval (in minutes) after drive day end that may be spent to reach the stop.

Product Availability

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

Specified by:

setDriveFlexibility in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestBreaksEnable

public boolean isRestBreaksEnable()
                           throws IOException,
                                  AutomationException

Indicates whether periodic rest breaks are enabled.

Description

Returns the periodic rest breaks property that the route may require during the drive day.

Remarks

Sets the RestBreaksEnable property to True if you want to have periodic rest breaks. You can set the rest duration using the RestDuration property.

Product Availability

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

Specified by:

isRestBreaksEnable in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestBreaksEnable

public void setRestBreaksEnable(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates whether periodic rest breaks are enabled.

Description

Sets the periodic rest breaks property that the route may require during the drive day.

Remarks

Sets the RestBreaksEnable property to True if you want to have periodic rest breaks. You can set the rest duration using the RestDuration property.

Product Availability

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

Specified by:

setRestBreaksEnable in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestDuration

public short getRestDuration()
                      throws IOException,
                             AutomationException

The duration of rest breaks in minutes.

Description

Returns the duration of the rest break in minutes.

Product Availability

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

Specified by:

getRestDuration in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestDuration

public void setRestDuration(short pVal)
                     throws IOException,
                            AutomationException

The duration of rest breaks in minutes.

Description

Sets the duration of the rest break in minutes.

Product Availability

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

Specified by:

setRestDuration in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveBetweenRest

public short getDriveBetweenRest()
                          throws IOException,
                                 AutomationException

Driving time between rest breaks in minutes.

Description

Returns the amount of time (in minutes) to drive between rest breaks.

Product Availability

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

Specified by:

getDriveBetweenRest in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveBetweenRest

public void setDriveBetweenRest(short pVal)
                         throws IOException,
                                AutomationException

Driving time between rest breaks in minutes.

Description

Sets the amount of time (in minutes) to drive between rest breaks.

Product Availability

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

Specified by:

setDriveBetweenRest in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.