com.esri.arcgis.trackinganalyst
Class TemporalOperator

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TemporalOperator
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, ITemporalOperator, ITemporalOperator2, ITemporalOperator3, Serializable

public class TemporalOperator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalOperator, ITemporalOperator2, ITemporalOperator3, IClone

Implements ITemporalOperator to identify and manage temporal playback settings.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TemporalOperator()
          Constructs a TemporalOperator using ArcGIS Engine.
TemporalOperator(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalOperator theTemporalOperator = (TemporalOperator) obj;
 
Method Summary
 void add(ITemporalOperator piOtherOperator)
          Adds a new temporal operator.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 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.
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 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 playback time interval between events.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TemporalOperator

public TemporalOperator()
                 throws IOException,
                        UnknownHostException
Constructs a TemporalOperator using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TemporalOperator

public TemporalOperator(Object obj)
                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalOperator theTemporalOperator = (TemporalOperator) obj;

Construct a TemporalOperator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TemporalOperator.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setDateTime

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

Specified by:
setDateTime in interface ITemporalOperator
Specified by:
setDateTime in interface ITemporalOperator2
Specified by:
setDateTime in interface ITemporalOperator3
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

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

Specified by:
setInterval in interface ITemporalOperator
Specified by:
setInterval in interface ITemporalOperator2
Specified by:
setInterval in interface ITemporalOperator3
Parameters:
dQuantity - The dQuantity (in)
enumUnits - A com.esri.arcgis.trackinganalyst.enumTemporalOperatorUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

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

Specified by:
getType in interface ITemporalOperator
Specified by:
getType in interface ITemporalOperator2
Specified by:
getType in interface ITemporalOperator3
Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalOperatorType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the temporal operator.

Product Availability

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

Specified by:
reset in interface ITemporalOperator
Specified by:
reset in interface ITemporalOperator2
Specified by:
reset in interface ITemporalOperator3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

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

Specified by:
add in interface ITemporalOperator
Specified by:
add in interface ITemporalOperator2
Specified by:
add in interface ITemporalOperator3
Parameters:
piOtherOperator - A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

subtract

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

Specified by:
subtract in interface ITemporalOperator
Specified by:
subtract in interface ITemporalOperator2
Specified by:
subtract in interface ITemporalOperator3
Parameters:
piOtherOperator - A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsString

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

Specified by:
getAsString in interface ITemporalOperator
Specified by:
getAsString in interface ITemporalOperator2
Specified by:
getAsString in interface ITemporalOperator3
Parameters:
bstrFormat - The bstrFormat (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsDate

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

Specified by:
getAsDate in interface ITemporalOperator
Specified by:
getAsDate in interface ITemporalOperator2
Specified by:
getAsDate in interface ITemporalOperator3
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsInterval

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

Specified by:
getAsInterval in interface ITemporalOperator
Specified by:
getAsInterval in interface ITemporalOperator2
Specified by:
getAsInterval in interface ITemporalOperator3
Parameters:
enumUnits - A com.esri.arcgis.trackinganalyst.enumTemporalOperatorUnits constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue()
                throws IOException,
                       AutomationException
Value of temporal information.

Product Availability

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

Specified by:
getValue in interface ITemporalOperator
Specified by:
getValue in interface ITemporalOperator2
Specified by:
getValue in interface ITemporalOperator3
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIntervalQuantity

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

Specified by:
getIntervalQuantity in interface ITemporalOperator
Specified by:
getIntervalQuantity in interface ITemporalOperator2
Specified by:
getIntervalQuantity in interface ITemporalOperator3
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIntervalUnits

public int getIntervalUnits()
                     throws IOException,
                            AutomationException
Units used for interval.

Product Availability

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

Specified by:
getIntervalUnits in interface ITemporalOperator
Specified by:
getIntervalUnits in interface ITemporalOperator2
Specified by:
getIntervalUnits in interface ITemporalOperator3
Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalOperatorUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDateTimeFromString

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

Specified by:
setDateTimeFromString in interface ITemporalOperator2
Specified by:
setDateTimeFromString in interface ITemporalOperator3
Parameters:
bstrDateTime - The bstrDateTime (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDateTimeFromVariant

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

Specified by:
setDateTimeFromVariant in interface ITemporalOperator2
Specified by:
setDateTimeFromVariant in interface ITemporalOperator3
Parameters:
dateTime - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

temporalUnitsAsString

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

Specified by:
temporalUnitsAsString in interface ITemporalOperator3
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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.