com.esri.arcgis.datasourcesraster
Class RasterStatus

java.lang.Object
  com.esri.arcgis.datasourcesraster.RasterStatus

All Implemented Interfaces:

IRasterStatus, IRasterStatus2, IRasterStatus3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterStatus
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStatus, IRasterStatus2, IRasterStatus3

The raster event listener object.

Remarks

The RasterStatus object, together with RasterStatusEventHelper and RasterStatusEvent2Helper event listener objects, can be used to track the status and progress of certain raster operations, such as building statistics and saving as to other raster formats.

RasterStatus is used as an event source, which send messages to the listeners. RasterStatusEventHelper and RasterStatusEvent2Helper listen to the event sent from RasterStatus

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

RasterStatus()
Constructs a RasterStatus using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	fireContinue(boolean[] bContinue) Broadcasts if the operation should be continued.
void	fireMessage(String message) Broadcasts the message of the operation.
void	fireStart(int min, int max) Fires a Start of a raster status event.
void	fireStep(int pos) Fires a Step of a raster status event.
void	fireStop() Fires a Step of a raster status event.
void	fireTitle(String title) Broadcasts the title of the operation.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
boolean	isSuspend() The status to be suspended.
void	setSuspend(boolean b) The status to be suspended.

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

RasterStatus

public RasterStatus()
             throws IOException,
                    UnknownHostException

Constructs a RasterStatus using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterStatus

public RasterStatus(Object obj)
             throws IOException

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

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

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

fireStart

public void fireStart(int min,
                      int max)
               throws IOException,
                      AutomationException

Fires a Start of a raster status event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireStart in interface IRasterStatus

Parameters:

min - The min (in)

max - The max (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireStep

public void fireStep(int pos)
              throws IOException,
                     AutomationException

Fires a Step of a raster status event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireStep in interface IRasterStatus

Parameters:

pos - The pos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireStop

public void fireStop()
              throws IOException,
                     AutomationException

Fires a Step of a raster status event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireStop in interface IRasterStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireTitle

public void fireTitle(String title)
               throws IOException,
                      AutomationException

Broadcasts the title of the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireTitle in interface IRasterStatus2

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireMessage

public void fireMessage(String message)
                 throws IOException,
                        AutomationException

Broadcasts the message of the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireMessage in interface IRasterStatus2

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireContinue

public void fireContinue(boolean[] bContinue)
                  throws IOException,
                         AutomationException

Broadcasts if the operation should be continued.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

fireContinue in interface IRasterStatus2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuspend

public void setSuspend(boolean b)
                throws IOException,
                       AutomationException

The status to be suspended.

Product Availability

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

Specified by:

setSuspend in interface IRasterStatus3

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuspend

public boolean isSuspend()
                  throws IOException,
                         AutomationException

The status to be suspended.

Product Availability

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

Specified by:

isSuspend in interface IRasterStatus3

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.