com.esri.arcgis.system
Interface ITimeRelationalOperator

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeExtent, TimeInstant

public interface ITimeRelationalOperator
extends Serializable

Provides access to time operations.

Description

The ITimeRelationalOperator provides many operations similar to spatial operations in a 1 dimentional timeline. when possible, it can use both TimeInstant and TimeExtent interfaces as parameters to the functions.

Product Availability

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

Method Summary

boolean	contains(ITimeValue otherTimeValue) Indicates whether this time value contains the other time value.
boolean	disjoint(ITimeValue otherTimeValue) Indicates whether the input time value falls fully outside of the time extent.
boolean	esri_equals(ITimeValue otherTimeValue) Indicates whether the two time values are of the same type and define the same time values.
boolean	touches(ITimeValue otherTimeValue) Indicates whether the boundaries of the time values intersect.
boolean	within(ITimeValue otherTimeValue) Indicates whether this time value is contained (is within) the other time value.

Method Detail

esri_equals

boolean esri_equals(ITimeValue otherTimeValue)
                    throws IOException,
                           AutomationException

Indicates whether the two time values are of the same type and define the same time values.

Product Availability

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

Parameters:

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

Returns:

The esri_equals

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disjoint

boolean disjoint(ITimeValue otherTimeValue)
                 throws IOException,
                        AutomationException

Indicates whether the input time value falls fully outside of the time extent.

Description

This is the opposite of the Touches operation. It can be used to find out if there is a non-zero amount of time between the input time and the current time extent.

Product Availability

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

Parameters:

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

Returns:

The disjoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

touches

boolean touches(ITimeValue otherTimeValue)
                throws IOException,
                       AutomationException

Indicates whether the boundaries of the time values intersect.

Description

This function results in a TRUE value if there exists a Time instant that is contained by both of the TimeExtents. for example if the time extents are 1:00-2:00 and 2:00-3:00, then there is exactly one moment in time (2:00) that is in both TimeExtents.

Product Availability

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

Parameters:

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

Returns:

The touches

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

within

boolean within(ITimeValue otherTimeValue)
               throws IOException,
                      AutomationException

Indicates whether this time value is contained (is within) the other time value.

Description

This function can be used to find out if the current time is contained fully within the time extent passed in. The start times can be equal or the end times can be equal and the function will still be TRUE.

Product Availability

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

Parameters:

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

Returns:

The within

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contains

boolean contains(ITimeValue otherTimeValue)
                 throws IOException,
                        AutomationException

Indicates whether this time value contains the other time value.

Description

This function returns true if the passed Time value is contained fully within the current time extent. The start times can be equal, or the end times can be equal and the function will still result in TRUE.

Product Availability

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

Parameters:

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

Returns:

The contains

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.