com.esri.arcgis.system
Interface ITimeExtent

All Superinterfaces:

ITimeValue, Serializable

All Known Implementing Classes:

TimeExtent

public interface ITimeExtent
extends ITimeValue, Serializable

Provides access to members that control the Time Extent.

Description

The ITimeExtent interface is used to work with a specific perid of time. It includes a Start Time and an End Time, but can also provide the length of time between the start time and the end time. Note that the period of time is contiguous, so there are no gaps in the ITimeExtent.

Product Availability

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

Method Summary

ITime	getEndTime() The time extent's end time.
ITime	getStartTime() The time extent's start time.
void	intersect(ITimeValue otherTimeValue) Adjust to intersect with the input time value.
boolean	isEmpty() Indicates whether the time extent is empty.
ITimeDuration	queryTimeDuration() Obtains the time extent's time duration.
void	setEmpty(boolean empty) Indicates whether the time extent is empty.
void	setEndTime(ITime endTime) The time extent's end time.
void	setExtent(ITime startTime, ITime endTime) Writes start and end time, with copies of the input time values.
void	setStartTime(ITime startTime) The time extent's start time.
void	union(ITimeValue otherTimeValue) Adjust to ovelap the input time value.

Methods inherited from interface com.esri.arcgis.system.ITimeValue

getTimeReference, project, projectFromUTC, projectToUTC, setTimeReferenceByRef

Method Detail

getStartTime

ITime getStartTime()
                   throws IOException,
                          AutomationException

The time extent's start time.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ITime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

void setStartTime(ITime startTime)
                  throws IOException,
                         AutomationException

The time extent's start time.

Description

The StartTime passed into this function must be before or equal to the current value of the EndTime property. To avoid problems, it is preferable to use the SetExtent method when setting both the start time and end time.

Product Availability

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

Parameters:

startTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

ITime getEndTime()
                 throws IOException,
                        AutomationException

The time extent's end time.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ITime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

void setEndTime(ITime endTime)
                throws IOException,
                       AutomationException

The time extent's end time.

Description

The passed value for EndTime must be after or equal to the current value of the StartTime property. To avoid problems, it is preferable to use the SetExtent method when setting both the start time and end time.

Product Availability

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

Parameters:

endTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates whether the time extent is empty.

Product Availability

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

Returns:

The empty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

void setEmpty(boolean empty)
              throws IOException,
                     AutomationException

Indicates whether the time extent is empty.

Product Availability

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

Parameters:

empty - The empty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(ITime startTime,
               ITime endTime)
               throws IOException,
                      AutomationException

Writes start and end time, with copies of the input time values.

Description

This function sets both the Start Time and End Time as one atomic action.

Product Availability

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

Parameters:

startTime - A reference to a com.esri.arcgis.system.ITime (in)

endTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTimeDuration

ITimeDuration queryTimeDuration()
                                throws IOException,
                                       AutomationException

Obtains the time extent's time duration.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ITimeDuration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

void union(ITimeValue otherTimeValue)
           throws IOException,
                  AutomationException

Adjust to ovelap the input time value.

Description

This method expands the current TimeExtent to include its previous extent and the extent of the passed TimeExtent. The result is continuous, so any gap between the previous extent and the passed extent is included in the new extent.

Product Availability

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

Parameters:

otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

void intersect(ITimeValue otherTimeValue)
               throws IOException,
                      AutomationException

Adjust to intersect with the input time value.

Description

The current extent is adjusted to include the time period (if any) where the original value intersects with the passed TimeExtent value.

Product Availability

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

Parameters:

otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.