com.esri.arcgis.trackinganalyst
Interface ITemporalReference

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITemporalReferenceProxy, TemporalReference

public interface ITemporalReference
extends java.io.Serializable

COM Interface 'ITemporalReference'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed to manage temporal reference information for a dataset.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID78c74237_17cf_11d5_b7cf_00010265adc5
static int	xxDummy Deprecated. Internal use only

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.
java.lang.Object	getTemporalPerspective() Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
java.lang.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(java.lang.Object pVal) Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Field Detail

IID78c74237_17cf_11d5_b7cf_00010265adc5

static final int IID78c74237_17cf_11d5_b7cf_00010265adc5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getTemporalPerspective

java.lang.Object getTemporalPerspective()
                                        throws java.io.IOException,
                                               AutomationException

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

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

void setTemporalPerspective(java.lang.Object pVal)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalMode

int getTemporalMode()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalMode constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalMode

void setTemporalMode(int pVal)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriod

double getTemporalPeriod()
                         throws java.io.IOException,
                                AutomationException

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

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriod

void setTemporalPeriod(double pVal)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriodUnits

int getTemporalPeriodUnits()
                           throws java.io.IOException,
                                  AutomationException

Describes the temporal units that define the temporal period property.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriodUnits

void setTemporalPeriodUnits(int pVal)
                            throws java.io.IOException,
                                   AutomationException

Describes the temporal units that define the temporal period property.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPerspectiveAsDate

java.lang.Object getTemporalPerspectiveAsDate()
                                              throws java.io.IOException,
                                                     AutomationException

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

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.