com.esri.arcgis.trackinganalyst
Class TemporalReference

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

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, ITemporalReference, Externalizable, Serializable

public class TemporalReference
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalReference, ISupportErrorInfo, IPersistStream, IConnectionPointContainer, IDocumentVersionSupportGEN, Externalizable

Maintains temporal perspective on data and notifies all clients when the value changes.

Description

This class defines the CoClass characteristics for the TemperalReference object. This object is responsible for holding the temporal perspective and to notify all interested clients when this value changes.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TemporalReference()
Constructs a TemporalReference using ArcGIS Engine.

TemporalReference(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalReference theTemporalReference = (TemporalReference) obj;

Method Summary

void	add_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener) add_ITemporalReferenceEventsListener.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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.
Object	getTemporalPerspective() Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
Object	getTemporalPerspectiveAsDate() The current temporal perspective in COleDateTime format, so the temporal perspective can be retrieved from VB.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	remove_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener) remove_ITemporalReferenceEventsListener.
void	save(IStream pstm, int fClearDirty) save
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(Object pVal) Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
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

TemporalReference

public TemporalReference()
                  throws IOException,
                         UnknownHostException

Constructs a TemporalReference using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TemporalReference

public TemporalReference(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalReference theTemporalReference = (TemporalReference) obj;

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

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

add_ITemporalReferenceEventsListener

public void add_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener)
                                          throws IOException

add_ITemporalReferenceEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._ITemporalReferenceEvents interface.

Throws:

IOException - If there are communications problems.

remove_ITemporalReferenceEventsListener

public void remove_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener)
                                             throws IOException

remove_ITemporalReferenceEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._ITemporalReferenceEvents interface.

Throws:

IOException - If there are communications problems.

getTemporalPerspective

public Object getTemporalPerspective()
                              throws IOException,
                                     AutomationException

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

Description

The Temporal Perspective property is a timestamp of the current temporal perspective in time. This property has different roles for each temporal mode. When the object's temporal mode is fixed-time, the Temporal Reference's Temporal Perspective property is a static timestamp. This facilitates the view of temporally based data within a layer at a particular point in time. When the object's temporal mode is real-time, this object automatically updates the temporal perspective at the RealTimeUpdateFrequency Properties rate. This facilitates real-time or current time viewing of temporally enabled data. Any update to this property fires an OnUpdate event whether is comes from internally, in real-time mode, or externally thought the interface. Additionally this property will set the internal variable to the current system time if a null value is provided. This facilitates individual layers requesting a temporal update and the re-draw request is managed for all layers in a map.

The format of this value is a CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

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

Specified by:

getTemporalPerspective in interface ITemporalReference

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

public void setTemporalPerspective(Object pVal)
                            throws IOException,
                                   AutomationException

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

Description

The Temporal Perspective property is a timestamp of the current temporal perspective in time. This property has different roles for each temporal mode. When the object's temporal mode is fixed-time, the Temporal Reference's Temporal Perspective property is a static timestamp. This facilitates the view of temporally based data within a layer at a particular point in time. When the object's temporal mode is real-time, this object automatically updates the temporal perspective at the RealTimeUpdateFrequency Properties rate. This facilitates real-time or current time viewing of temporally enabled data. Any update to this property fires an OnUpdate event whether is comes from internally, in real-time mode, or externally thought the interface. Additionally this property will set the internal variable to the current system time if a null value is provided. This facilitates individual layers requesting a temporal update and the re-draw request is managed for all layers in a map.

The format of this value is a CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

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

Specified by:

setTemporalPerspective in interface ITemporalReference

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalMode

public int getTemporalMode()
                    throws IOException,
                           AutomationException

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

Description

The TemporalMode property controls the behavior of the temporal reference. This property can have two values:

• enumRealTime : RealTime Mode is when the computers system clock drives the temporal perspective value. A On Update event if fired each time the TemporalPerspective Property is changed. This change is based on the RealTimeUpdateFrequency property.
• enumHistoric: enumHistoric Mode enable a static time to be placed in the Temporal Perspective Property of the TemporalReference Object. An OnUpdate event is fired when the perspectives TemporalPerspective property is changed.

Product Availability

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

Specified by:

getTemporalMode in interface ITemporalReference

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalMode

public void setTemporalMode(int pVal)
                     throws IOException,
                            AutomationException

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

Description

The TemporalMode property controls the behavior of the temporal reference. This property can have two values:

• enumRealTime : RealTime Mode is when the computers system clock drives the temporal perspective value. A On Update event if fired each time the TemporalPerspective Property is changed. This change is based on the RealTimeUpdateFrequency property.
• enumHistoric: enumHistoric Mode enable a static time to be placed in the Temporal Perspective Property of the TemporalReference Object. An OnUpdate event is fired when the perspectives TemporalPerspective property is changed.

Product Availability

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

Specified by:

setTemporalMode in interface ITemporalReference

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriod

public double getTemporalPeriod()
                         throws IOException,
                                AutomationException

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

Description

This property is used by the Temporal Renderer property page to determine the default period of time to create Temporal legend classes for its temporal legend group.

Product Availability

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

Specified by:

getTemporalPeriod in interface ITemporalReference

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriod

public void setTemporalPeriod(double pVal)
                       throws IOException,
                              AutomationException

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

Description

This property is used by the Temporal Renderer property page to determine the default period of time to create Temporal legend classes for its temporal legend group.

Product Availability

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

Specified by:

setTemporalPeriod in interface ITemporalReference

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriodUnits

public int getTemporalPeriodUnits()
                           throws IOException,
                                  AutomationException

Describes the temporal units that define the temporal period property.

Description

This property describes the temporal units that the Temporal Period property is based on.

Product Availability

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

Specified by:

getTemporalPeriodUnits in interface ITemporalReference

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriodUnits

public void setTemporalPeriodUnits(int pVal)
                            throws IOException,
                                   AutomationException

Describes the temporal units that define the temporal period property.

Description

This property describes the temporal units that the Temporal Period property is based on.

Product Availability

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

Specified by:

setTemporalPeriodUnits in interface ITemporalReference

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPerspectiveAsDate

public Object getTemporalPerspectiveAsDate()
                                    throws IOException,
                                           AutomationException

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

Description

This property will return the current temporal perspective in COleDateTime Format so that the Temporal Perspective can be gotten from VB.

Product Availability

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

Specified by:

getTemporalPerspectiveAsDate in interface ITemporalReference

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

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.

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer 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:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer 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:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (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