com.esri.arcgis.animation
Class TimeLayerTrackExtension

java.lang.Object
  extended by com.esri.arcgis.animation.TimeLayerTrackExtension
All Implemented Interfaces:
ITimeLayerTrackExtension, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class TimeLayerTrackExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeLayerTrackExtension, IClone, IPersistStream, Externalizable

Time Layer Track Extension.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TimeLayerTrackExtension()
          Constructs a TimeLayerTrackExtension using ArcGIS Engine.
TimeLayerTrackExtension(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeLayerTrackExtension theTimeLayerTrackExtension = (TimeLayerTrackExtension) obj;
 
Method Summary
 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.
 IArray getAttachedObjects()
          Provides access to the objects attached to the track.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ITimeWindow getTimeWindow(IAGAnimationTrack pTrack, Object pObject)
          Provides access to the time window for the given object.
 IArray getTimeWindows()
          Provides access to the time windows for the objects attached to the track.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 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.
 boolean isShowTrackName()
          Indicates whether to show the track name.
 boolean isShowTrackTime()
          Indicates whether to show the track time.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setShowTrackName(boolean pShowTrackName)
          Indicates whether to show the track name.
 void setShowTrackTime(boolean pShowTrackTime)
          Indicates whether to show the track time.
 void updateTrackExtension(IAGAnimationTrack pTrack)
          Provides access to the objects attached to the track.
 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

TimeLayerTrackExtension

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

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

TimeLayerTrackExtension

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

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

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

getTimeWindow

public ITimeWindow getTimeWindow(IAGAnimationTrack pTrack,
                                 Object pObject)
                          throws IOException,
                                 AutomationException
Provides access to the time window for the given object.

Remarks

Get the time window for a specific time animation object.

Product Availability

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

Specified by:
getTimeWindow in interface ITimeLayerTrackExtension
Parameters:
pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
pObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.animation.ITimeWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeWindows

public IArray getTimeWindows()
                      throws IOException,
                             AutomationException
Provides access to the time windows for the objects attached to the track.

Remarks

This property allows you to access the time windows of all the time layers that are attached to the time track.

Product Availability

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

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

getAttachedObjects

public IArray getAttachedObjects()
                          throws IOException,
                                 AutomationException
Provides access to the objects attached to the track.

Product Availability

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

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

updateTrackExtension

public void updateTrackExtension(IAGAnimationTrack pTrack)
                          throws IOException,
                                 AutomationException
Provides access to the objects attached to the track.

Product Availability

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

Specified by:
updateTrackExtension in interface ITimeLayerTrackExtension
Parameters:
pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTrackName

public void setShowTrackName(boolean pShowTrackName)
                      throws IOException,
                             AutomationException
Indicates whether to show the track name.

Product Availability

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

Specified by:
setShowTrackName in interface ITimeLayerTrackExtension
Parameters:
pShowTrackName - The pShowTrackName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTrackName

public boolean isShowTrackName()
                        throws IOException,
                               AutomationException
Indicates whether to show the track name.

Product Availability

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

Specified by:
isShowTrackName in interface ITimeLayerTrackExtension
Returns:
The pShowTrackName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTrackTime

public void setShowTrackTime(boolean pShowTrackTime)
                      throws IOException,
                             AutomationException
Indicates whether to show the track time.

Product Availability

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

Specified by:
setShowTrackTime in interface ITimeLayerTrackExtension
Parameters:
pShowTrackTime - The pShowTrackTime (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTrackTime

public boolean isShowTrackTime()
                        throws IOException,
                               AutomationException
Indicates whether to show the track time.

Product Availability

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

Specified by:
isShowTrackTime in interface ITimeLayerTrackExtension
Returns:
The pShowTrackTime
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.

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.

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