com.esri.arcgis.geodatabaseextensions
Interface ITemporalOperator

All Superinterfaces:

Serializable

All Known Implementing Classes:

TemporalOperator

public interface ITemporalOperator
extends Serializable

Provides access to methods and properties used to identify and manage temporal playback settings.

Product Availability

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

Method Summary

void	add(ITemporalOperator piOtherOperator) Adds a new temporal operator.
Object	getAsDate() Temporal information as a date field.
Object	getAsInterval(int enumUnits) Temporal information as an interval value.
String	getAsString(String bstrFormat) Temporal information as a string.
double	getIntervalQuantity() Number of intervals between events.
int	getIntervalUnits() Units used for interval.
int	getType() The type of temporal data used.
Object	getValue() Value of temporal information.
void	reset() Resets the temporal operator.
void	setDateTime(int lYear, short lMonth, short lDayOfMonth, short lHour, short lMinute, short lSecond, short lMillisecond) Sets the value for date and time information.
void	setInterval(double dQuantity, int enumUnits) Sets the playback time interval between events.
void	subtract(ITemporalOperator piOtherOperator) Subtracts a temporal operator.

Method Detail

setDateTime

void setDateTime(int lYear,
                 short lMonth,
                 short lDayOfMonth,
                 short lHour,
                 short lMinute,
                 short lSecond,
                 short lMillisecond)
                 throws IOException,
                        AutomationException

Sets the value for date and time information.

Product Availability

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

Parameters:

lYear - The lYear (in)

lMonth - The lMonth (in)

lDayOfMonth - The lDayOfMonth (in)

lHour - The lHour (in)

lMinute - The lMinute (in)

lSecond - The lSecond (in)

lMillisecond - The lMillisecond (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInterval

void setInterval(double dQuantity,
                 int enumUnits)
                 throws IOException,
                        AutomationException

Sets the playback time interval between events.

Product Availability

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

Parameters:

dQuantity - The dQuantity (in)

enumUnits - A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

The type of temporal data used.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the temporal operator.

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.

add

void add(ITemporalOperator piOtherOperator)
         throws IOException,
                AutomationException

Adds a new temporal operator.

Product Availability

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

Parameters:

piOtherOperator - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

subtract

void subtract(ITemporalOperator piOtherOperator)
              throws IOException,
                     AutomationException

Subtracts a temporal operator.

Product Availability

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

Parameters:

piOtherOperator - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsString

String getAsString(String bstrFormat)
                   throws IOException,
                          AutomationException

Temporal information as a string.

Product Availability

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

Parameters:

bstrFormat - The bstrFormat (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsDate

Object getAsDate()
                 throws IOException,
                        AutomationException

Temporal information as a date field.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsInterval

Object getAsInterval(int enumUnits)
                     throws IOException,
                            AutomationException

Temporal information as an interval value.

Product Availability

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

Parameters:

enumUnits - A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue()
                throws IOException,
                       AutomationException

Value of temporal information.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntervalQuantity

double getIntervalQuantity()
                           throws IOException,
                                  AutomationException

Number of intervals between events.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntervalUnits

int getIntervalUnits()
                     throws IOException,
                            AutomationException

Units used for interval.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.