com.esri.arcgis.trackinganalyst
Interface ITemporalReference

All Superinterfaces:

Serializable

All Known Implementing Classes:

TemporalReference

public interface ITemporalReference
extends Serializable

Provides access to properties and methods needed to manage temporal reference information for a dataset.

Description

The Temporal Reference interface provides a standard way to define the temporal reference of data. This interface provides the necessary properties to exploit data in two modes: real-time and fixed-time (historical). Real-time mode uses the system clock as the temporal perspective and issues update events at the frequency dictated by the update frequency property. The time is further filtered to a period of time from the current time to a time in the past equal to the period property. This provides all of the required properties to define a temporal reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

int	getTemporalMode() Controls the behavior of temporal reference to reflect real-time or playback mode.
double	getTemporalPeriod() Used by the temporal renderer property page to determine the default time period for the temporal legend classes.
int	getTemporalPeriodUnits() Describes the temporal units that define the temporal period property.
Object	getTemporalPerspective() Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
Object	getTemporalPerspectiveAsDate() The current temporal perspective in COleDateTime format, so the temporal perspective can be retrieved from VB.
void	setTemporalMode(int pVal) Controls the behavior of temporal reference to reflect real-time or playback mode.
void	setTemporalPeriod(double pVal) Used by the temporal renderer property page to determine the default time period for the temporal legend classes.
void	setTemporalPeriodUnits(int pVal) Describes the temporal units that define the temporal period property.
void	setTemporalPerspective(Object pVal) Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Method Detail

getTemporalPerspective

Object getTemporalPerspective()
                              throws IOException,
                                     AutomationException

Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Description

The Temporal Perspective property is a timestamp of the current temporal perspective in time. This property has different roles for each temporal mode. When the object's temporal mode is fixed-time, the Temporal Reference's Temporal Perspective property is a static timestamp. This facilitates the view of temporally based data within a layer at a particular point in time. When the object's temporal mode is real-time, this object automatically updates the temporal perspective at the RealTimeUpdateFrequency Properties rate. This facilitates real-time or current time viewing of temporally enabled data. Any update to this property fires an OnUpdate event whether is comes from internally, in real-time mode, or externally thought the interface. Additionally this property will set the internal variable to the current system time if a null value is provided. This facilitates individual layers requesting a temporal update and the re-draw request is managed for all layers in a map.

The format of this value is a CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

void setTemporalPerspective(Object pVal)
                            throws IOException,
                                   AutomationException

Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Description

The Temporal Perspective property is a timestamp of the current temporal perspective in time. This property has different roles for each temporal mode. When the object's temporal mode is fixed-time, the Temporal Reference's Temporal Perspective property is a static timestamp. This facilitates the view of temporally based data within a layer at a particular point in time. When the object's temporal mode is real-time, this object automatically updates the temporal perspective at the RealTimeUpdateFrequency Properties rate. This facilitates real-time or current time viewing of temporally enabled data. Any update to this property fires an OnUpdate event whether is comes from internally, in real-time mode, or externally thought the interface. Additionally this property will set the internal variable to the current system time if a null value is provided. This facilitates individual layers requesting a temporal update and the re-draw request is managed for all layers in a map.

The format of this value is a CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalMode

int getTemporalMode()
                    throws IOException,
                           AutomationException

Controls the behavior of temporal reference to reflect real-time or playback mode.

Description

The TemporalMode property controls the behavior of the temporal reference. This property can have two values:

• enumRealTime : RealTime Mode is when the computers system clock drives the temporal perspective value. A On Update event if fired each time the TemporalPerspective Property is changed. This change is based on the RealTimeUpdateFrequency property.
• enumHistoric: enumHistoric Mode enable a static time to be placed in the Temporal Perspective Property of the TemporalReference Object. An OnUpdate event is fired when the perspectives TemporalPerspective property is changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalMode

void setTemporalMode(int pVal)
                     throws IOException,
                            AutomationException

Controls the behavior of temporal reference to reflect real-time or playback mode.

Description

The TemporalMode property controls the behavior of the temporal reference. This property can have two values:

• enumRealTime : RealTime Mode is when the computers system clock drives the temporal perspective value. A On Update event if fired each time the TemporalPerspective Property is changed. This change is based on the RealTimeUpdateFrequency property.
• enumHistoric: enumHistoric Mode enable a static time to be placed in the Temporal Perspective Property of the TemporalReference Object. An OnUpdate event is fired when the perspectives TemporalPerspective property is changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriod

double getTemporalPeriod()
                         throws IOException,
                                AutomationException

Used by the temporal renderer property page to determine the default time period for the temporal legend classes.

Description

This property is used by the Temporal Renderer property page to determine the default period of time to create Temporal legend classes for its temporal legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriod

void setTemporalPeriod(double pVal)
                       throws IOException,
                              AutomationException

Used by the temporal renderer property page to determine the default time period for the temporal legend classes.

Description

This property is used by the Temporal Renderer property page to determine the default period of time to create Temporal legend classes for its temporal legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriodUnits

int getTemporalPeriodUnits()
                           throws IOException,
                                  AutomationException

Describes the temporal units that define the temporal period property.

Description

This property describes the temporal units that the Temporal Period property is based on.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriodUnits

void setTemporalPeriodUnits(int pVal)
                            throws IOException,
                                   AutomationException

Describes the temporal units that define the temporal period property.

Description

This property describes the temporal units that the Temporal Period property is based on.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPerspectiveAsDate

Object getTemporalPerspectiveAsDate()
                                    throws IOException,
                                           AutomationException

The current temporal perspective in COleDateTime format, so the temporal perspective can be retrieved from VB.

Description

This property will return the current temporal perspective in COleDateTime Format so that the Temporal Perspective can be gotten from VB.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.