com.esri.arcgis.trackinganalyst
Interface ITemporalOperator3

All Superinterfaces:

Serializable

All Known Implementing Classes:

TemporalOperator

public interface ITemporalOperator3
extends Serializable

Provides access to additional methods and properties used to configure the temporal operator beyond ITemporalOperator2 and ITemporalOperator.

Product Availability

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

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	setDateTimeFromString(String bstrDateTime) Sets the value for date and time information from a string.
void	setDateTimeFromVariant(Object dateTime) Sets the value for date and time information from a variant.
void	setInterval(double dQuantity, int enumUnits) Sets the time interval.
void	subtract(ITemporalOperator piOtherOperator) Subtracts a temporal operator.
void	temporalUnitsAsString(int eUnits, int eAppearance, boolean bvPlural, String[] pbstrUnitString) Obtains a string representation of a temporal unit enumeration, in upper, lower, or mixed case, with singular or plural form.

Method Detail

temporalUnitsAsString

void temporalUnitsAsString(int eUnits,
                           int eAppearance,
                           boolean bvPlural,
                           String[] pbstrUnitString)
                           throws IOException,
                                  AutomationException

Obtains a string representation of a temporal unit enumeration, in upper, lower, or mixed case, with singular or plural form.

Product Availability

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

Parameters:

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

eAppearance - A com.esri.arcgis.system.esriCaseAppearance constant (in)

bvPlural - The bvPlural (in)

pbstrUnitString - The pbstrUnitString (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateTimeFromString

void setDateTimeFromString(String bstrDateTime)
                           throws IOException,
                                  AutomationException

Sets the value for date and time information from a string.

Product Availability

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

Parameters:

bstrDateTime - The bstrDateTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateTimeFromVariant

void setDateTimeFromVariant(Object dateTime)
                            throws IOException,
                                   AutomationException

Sets the value for date and time information from a variant.

Product Availability

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

Parameters:

dateTime - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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. Requires Tracking Analyst Extension.

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 time interval.

Product Availability

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

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

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. Requires Tracking Analyst Extension.

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.