com.esri.arcgis.system
Interface ITimeValue

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITimeExtent, ITimeInstant

All Known Implementing Classes:

TimeExtent, TimeInstant

public interface ITimeValue
extends Serializable

Provides access to members that control the Time Value.

Description

This interface allows you to access the TimeReference for a given time value. It provides a way to get the time value's time reference, and also change the time reference by projecting the value into a different temporal reference.

Product Availability

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

Method Summary

ITimeReference	getTimeReference() The time reference associated with the time value.
void	project(ITimeReference timeReference) Projects this time value from its time reference, to a given time reference.
void	projectFromUTC() Projects this time value from UTC, to its time reference.
void	projectToUTC() Projects this time value from its time reference, to UTC.
void	setTimeReferenceByRef(ITimeReference timeReference) The time reference associated with the time value.

Method Detail

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

The time reference associated with the time value.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference timeReference)
                           throws IOException,
                                  AutomationException

The time reference associated with the time value.

Product Availability

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

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

project

void project(ITimeReference timeReference)
             throws IOException,
                    AutomationException

Projects this time value from its time reference, to a given time reference.

Description

This function modifies the underlying time value in addition to changing the value of the temporal reference. For example, if you have a time value whose time reference is in Pacific Time Zone, and is currently 6:00 AM. The equivalent time in Eastern Time Zone is 9:00 AM. Calling the Project method, and passing in a reference to the Eastern time zone will change the time reference to the Eastern Time Zone, and also change the value to 9:00 AM.

Product Availability

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

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectToUTC

void projectToUTC()
                  throws IOException,
                         AutomationException

Projects this time value from its time reference, to UTC.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectFromUTC

void projectFromUTC()
                    throws IOException,
                           AutomationException

Projects this time value from UTC, to its time reference.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.