ObservationParameters

The ObservationParameters class is used to set filter conditions for the IntermediateResultReceiver, so that only intermediate results meeting specific conditions will be called back.

Definition

Package: com.dynamsoft.core.intermediate_results

public final class ObservationParameters

Methods

setObservedResultUnitTypes

Sets the types of intermediate result units that have been observed.

void setObservedResultUnitTypes(long types)

Parameters

types The observed types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

getObservedResultUnitTypes

Gets the types of intermediate result units that have been observed.

long getObservedResultUnitTypes()

Return value

The observed types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

isResultUnitTypeObserved

Determines whether the specified result unit type was observed.

boolean isResultUnitTypeObserved(@EnumIntermediateResultUnitType long type)

Parameters

type The type of intermediate result units. This is one of the values of the EnumIntermediateResultUnitType enumeration.

Return value

Returns a boolean value indicating whether the specified result unit type was observed.

See Also

EnumIntermediateResultUnitType

addObservedTask

Adds observed task name to be notified when relevant results are available.

void addObservedTask(String taskName)

Parameters

taskName The specified task name.

removeObservedTask

Remove the observed task name so that intermediate results generated by the task are not notified.

void removeObservedTask(String taskName)

Parameters

taskName The specified task name.

isTaskObserved

Determines whether the specified task was observed.

boolean isTaskObserved(String taskName)

Parameters

taskName The specified task name.

Return value

Returns a boolean value indicating whether the specified task was observed.

setResultUnitTypesOnlyForInput

Sets the types of intermediate result unit that indicates skipping default calculations and replacing with input data units.

void setResultUnitTypesOnlyForInput(long types)

Parameters

types The types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

getResultUnitTypesOnlyForInput

Gets the types of intermediate result unit that indicates skipping default calculations and replacing with input data units.

long getResultUnitTypesOnlyForInput()

Return value

Returns the types of intermediate result units. This is a bitwise OR combination of one or more values from the EnumIntermediateResultUnitType enumeration.

See Also

EnumIntermediateResultUnitType

isResultUnitTypeOnlyForInput

Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

boolean isResultUnitTypeOnlyForInput(@EnumIntermediateResultUnitType long type)

Parameters

type The type of intermediate result unit to check. This is one of the values of the EnumIntermediateResultUnitType enumeration.

Return value

Returns a boolean value indicating whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

See Also

EnumIntermediateResultUnitType