net.sourceforge.tess4j

Class ITessAPI.ETEXT_DESC

java.lang.Object

com.sun.jna.Structure

net.sourceforge.tess4j.ITessAPI.ETEXT_DESC

Enclosing interface:

ITessAPI

public static class ITessAPI.ETEXT_DESC
extends com.sun.jna.Structure

Description of the output of the OCR engine. This structure is used as both a progress monitor and the final output header, since it needs to be a valid progress monitor while the OCR engine is storing its output to shared memory. During progress, all the buffer info is -1. Progress starts at 0 and increases to 100 during OCR. No other constraint. Every progress callback, the OCR engine must set ocr_alive to 1. The HP side will set ocr_alive to 0. Repeated failure to reset to 1 indicates that the OCR engine is dead. If the cancel function is not null then it is called with the number of user words found. If it returns true then operation is cancelled.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.ByReference, com.sun.jna.Structure.ByValue, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
ITessAPI.CANCEL_FUNC	cancel returns true to cancel
com.sun.jna.Pointer	cancel_this this or other data for cancel
short	count chars in this buffer(0).
ITessAPI.TimeVal	end_time time to stop if not 0
byte	err_code for errcode use
byte	more_to_come true if not last
byte	ocr_alive ocr sets to 1, HP 0
short	progress percent complete increasing (0-100)
ITessAPI.EANYCODE_CHAR[]	text character data

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
ETEXT_DESC()

Method Summary

Modifier and Type	Method and Description
protected java.util.List	getFieldOrder() Gets Field Order.

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, clear, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

count

public short count

chars in this buffer(0). Total number of UTF-8 bytes for this run.

progress

public short progress

percent complete increasing (0-100)

more_to_come

public byte more_to_come

true if not last

ocr_alive

public byte ocr_alive

ocr sets to 1, HP 0

err_code

public byte err_code

for errcode use

cancel

public ITessAPI.CANCEL_FUNC cancel

returns true to cancel

cancel_this

public com.sun.jna.Pointer cancel_this

this or other data for cancel

end_time

public ITessAPI.TimeVal end_time

time to stop if not 0

text

public ITessAPI.EANYCODE_CHAR[] text

character data

Constructor Detail

ETEXT_DESC

public ETEXT_DESC()

Method Detail

getFieldOrder

protected java.util.List getFieldOrder()

Gets Field Order.

Specified by:

getFieldOrder in class com.sun.jna.Structure

Returns: