com.esri.arcgis.trackinganalyst
Class TemporalOperator

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalOperator

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITemporalOperator, ITemporalOperator2, ITemporalOperator3, Externalizable, Serializable

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

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.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getIntervalQuantity() Number of intervals between events.
int	getIntervalUnits() Units used for interval.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of temporal data used.
Object	getValue() Value of temporal information.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	reset() Resets the temporal operator.
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

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

Indicates if 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

Indicates if 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.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException