com.esri.arcgis.carto
Interface IMapTimeDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapDescription

public interface IMapTimeDescription
extends Serializable

Provides access to time properties of a MapDescription.

Product Availability

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

Method Summary

ITimeReference	getTimeReference() Time reference used by the time aware content.
ITimeValue	getTimeValue() Time value that will be used by the time aware content of the map.
void	setTimeReferenceByRef(ITimeReference timeReference) Time reference used by the time aware content.
void	setTimeValueByRef(ITimeValue timeValue) Time value that will be used by the time aware content of the map.

Method Detail

getTimeValue

ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

Time value that will be used by the time aware content of the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

void setTimeValueByRef(ITimeValue timeValue)
                       throws IOException,
                              AutomationException

Time value that will be used by the time aware content of the map.

Product Availability

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

Parameters:

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

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference used by the time aware content.

Remarks

You should set this property when the TimeValue that you are passing in is in different timezone that any of the dataframe's or layer's TimeReference in the MapServer.

When TimeReference is set to Null/Nothing, MapServer assumes the TimeValue is in layer's TimeReference while searching features from layer. For example, there may be two layers in the map, one is in Pacific Standard Time (PST) and the other is in Eastern Standard Time (EST). If the TimeValue you are passing in is PST, but you have TimeReference is set to Null, when MapServer searches for feature for the first layer, it will assume the input TimeValue is in PST and find the correct features. While it searches for the features from the second layer, it will assume the input TimeValue is in EST and will get incorrect features.

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

Time reference used by the time aware content.

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.