Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent Class Reference

An event that indicates Image processing progress information is available. More...

Inheritance diagram for com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent:

Public Member Functions

 AnalysisProgressEvent (Object sender, ErrorInfo status, String imageID, int progressPct)
 Creates a new ProcessProgressEvent with the given parameters. More...
 
ErrorInfo getStatus ()
 Gets the status property for the AnalysisProgressEvent. More...
 
String getImageID ()
 Gets the ImageID string for the AnalysisProgressEvent. More...
 
int getProgressPct ()
 Gets the analysis percentage for the progress event. More...
 

Detailed Description

An event that indicates Image processing progress information is available.

This event is raised in response to image processing progress information being available following a call to processImage. The event includes status information, Image ID string, and the progress percentage value. The Image ID references the Image object that was passed to processImage originally.

See also
ImageProcessor::processImage

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent.AnalysisProgressEvent ( Object  sender,
ErrorInfo  status,
String  imageID,
int  progressPct 
)
inline

Creates a new ProcessProgressEvent with the given parameters.

Member Function Documentation

String com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent.getImageID ( )
inline

Gets the ImageID string for the AnalysisProgressEvent.

The ImageID string identifies the Image being processed.

Returns
ImageID string
int com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent.getProgressPct ( )
inline

Gets the analysis percentage for the progress event.

The progressPct is an integer percentage value (0..100) indicating the progress of the image analysis operation.

Returns
progressPct
ErrorInfo com.kofax.kmc.ken.engines.ImageProcessor.AnalysisProgressEvent.getStatus ( )
inline

Gets the status property for the AnalysisProgressEvent.

The status property includes a status code and a message string.

Returns
ErrorInfo status

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.