com.esri.arcgis.datasourcesfile
Interface ISMTripPlanSettings

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISMTripPlanSettingsProxy, SMTripPlanSettings

public interface ISMTripPlanSettings
extends Serializable

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.

Method Summary

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	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.

Method Detail

isTripPlanningEnable

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripPlanningEnable

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTripStart

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripStart

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveStart

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveStart

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveEnd

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveEnd

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveFlexibility

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveFlexibility

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestBreaksEnable

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestBreaksEnable

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestDuration

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestDuration

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveBetweenRest

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveBetweenRest

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.