com.esri.arcgis.datasourcesfile
Class SMTripPlanSettings

java.lang.Object
  com.esri.arcgis.datasourcesfile.SMTripPlanSettings

All Implemented Interfaces:

ISMTripPlanSettings, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class SMTripPlanSettings
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMTripPlanSettings

COM Class 'SMTripPlanSettings'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesFile.olb'

Description 'Deprecated as of 10.1. The object that controls trip plan settings.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesfile.ISMTripPlanSettings

DISPID_1_GET_NAME, DISPID_1_PUT_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_GET_NAME, DISPID_8_PUT_NAME, IID, IIDf8b6600b_5850_11d7_b321_008048db11de, xxDummy

Constructor Summary

SMTripPlanSettings(java.lang.Object obj)
Construct a SMTripPlanSettings using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.util.Date	getDayDriveEnd() Time from midnight when driving must stop every day.
java.util.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
short	getRestDuration() The duration of rest breaks in minutes.
java.util.Date	getTripStart() The start date of the trip.
int	hashCode() the hashcode for this object
boolean	isRestBreaksEnable() Indicates whether periodic rest breaks are enabled.
boolean	isTripPlanningEnable() Indicates whether trip planning is enabled.
void	release() Release a SMTripPlanSettings.
void	setDayDriveEnd(java.util.Date pVal) Time from midnight when driving must stop every day.
void	setDayDriveStart(java.util.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(java.util.Date pVal) The start date of the trip.

Methods inherited from class java.lang.Object

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

Constructor Detail

SMTripPlanSettings

public SMTripPlanSettings(java.lang.Object obj)
                   throws java.io.IOException

Construct a SMTripPlanSettings using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SMTripPlanSettings.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SMTripPlanSettings o = (SMTripPlanSettings)obj; // will not work

SMTripPlanSettings o = new SMTripPlanSettings(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems SMTripPlanSettings theSMTripPlanSettings = (SMTripPlanSettings) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SMTripPlanSettings.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

isTripPlanningEnable

public boolean isTripPlanningEnable()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether trip planning is enabled.

Specified by:

isTripPlanningEnable in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripPlanningEnable

public void setTripPlanningEnable(boolean pVal)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether trip planning is enabled.

Specified by:

setTripPlanningEnable in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTripStart

public java.util.Date getTripStart()
                            throws java.io.IOException,
                                   AutomationException

The start date of the trip.

Specified by:

getTripStart in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTripStart

public void setTripStart(java.util.Date pVal)
                  throws java.io.IOException,
                         AutomationException

The start date of the trip.

Specified by:

setTripStart in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveStart

public java.util.Date getDayDriveStart()
                                throws java.io.IOException,
                                       AutomationException

Time from midnight when driving must start every day.

Specified by:

getDayDriveStart in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveStart

public void setDayDriveStart(java.util.Date pVal)
                      throws java.io.IOException,
                             AutomationException

Time from midnight when driving must start every day.

Specified by:

setDayDriveStart in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDayDriveEnd

public java.util.Date getDayDriveEnd()
                              throws java.io.IOException,
                                     AutomationException

Time from midnight when driving must stop every day.

Specified by:

getDayDriveEnd in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayDriveEnd

public void setDayDriveEnd(java.util.Date pVal)
                    throws java.io.IOException,
                           AutomationException

Time from midnight when driving must stop every day.

Specified by:

setDayDriveEnd in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveFlexibility

public short getDriveFlexibility()
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

getDriveFlexibility in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveFlexibility

public void setDriveFlexibility(short pVal)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setDriveFlexibility in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestBreaksEnable

public boolean isRestBreaksEnable()
                           throws java.io.IOException,
                                  AutomationException

Indicates whether periodic rest breaks are enabled.

Specified by:

isRestBreaksEnable in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestBreaksEnable

public void setRestBreaksEnable(boolean pVal)
                         throws java.io.IOException,
                                AutomationException

Indicates whether periodic rest breaks are enabled.

Specified by:

setRestBreaksEnable in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestDuration

public short getRestDuration()
                      throws java.io.IOException,
                             AutomationException

The duration of rest breaks in minutes.

Specified by:

getRestDuration in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestDuration

public void setRestDuration(short pVal)
                     throws java.io.IOException,
                            AutomationException

The duration of rest breaks in minutes.

Specified by:

setRestDuration in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDriveBetweenRest

public short getDriveBetweenRest()
                          throws java.io.IOException,
                                 AutomationException

Driving time between rest breaks in minutes.

Specified by:

getDriveBetweenRest in interface ISMTripPlanSettings

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDriveBetweenRest

public void setDriveBetweenRest(short pVal)
                         throws java.io.IOException,
                                AutomationException

Driving time between rest breaks in minutes.

Specified by:

setDriveBetweenRest in interface ISMTripPlanSettings

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.