Resource Base
Table of contents

CObservationParameters

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

Definition

Namespace: dynamsoft::intermediate_results

Assembly: DynamsoftCore

class CObservationParameters 

Methods Summary

Method Description
SetObservedResultUnitTypes Sets the types of intermediate result units that have been observed.
GetObservedResultUnitTypes Gets the types of intermediate result units that have been observed.
IsResultUnitTypeObserved Determines whether the specified result unit type was observed.
AddObservedTask Adds observed task name to be notified when relevant results are available.
RemoveObservedTask Remove the observed task name so that intermediate results generated by the task are not notified.
IsTaskObserved Determines whether the specified task was observed.
SetResultUnitTypesOnlyForInput Set the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
GetResultUnitTypesOnlyForInput Gets the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
IsResultUnitTypeOnlyForInput Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

SetObservedResultUnitTypes

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

void SetObservedResultUnitTypes(unsigned long long types) 

Parameters

[in] types The observed types of intermediate result units.

See Also

IntermediateResultUnitType

GetObservedResultUnitTypes

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

unsigned long long GetObservedResultUnitTypes() const

Return value

The observed types of intermediate result units.

See Also

IntermediateResultUnitType

IsResultUnitTypeObserved

Determines whether the specified result unit type was observed.

bool IsResultUnitTypeObserved(IntermediateResultUnitType type) const

Return value

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

See Also

IntermediateResultUnitType

AddObservedTask

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

void AddObservedTask(const char* taskName)

Parameters

[in] taskName The specified task name.

RemoveObservedTask

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

void RemoveObservedTask(const char* taskName)

Parameters

[in] taskName The specified task name.

IsTaskObserved

Determines whether the specified task was observed.

bool IsTaskObserved(const char* taskName) const

Parameters

[in] taskName The specified task name.

Return value

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

SetResultUnitTypesOnlyForInput

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

virtual void SetResultUnitTypesOnlyForInput(unsigned long long types) = 0;

Parameters

types: The type of intermediate result unit that serves as the combination value of IntermediateResultUnitType.

GetResultUnitTypesOnlyForInput

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

virtual unsigned long long GetResultUnitTypesOnlyForInput() const = 0;

Return

Returns the type of intermediate result unit that serves as the combination value of IntermediateResultUnitType.

IsResultUnitTypeOnlyForInput

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

virtual bool IsResultUnitTypeOnlyForInput(IntermediateResultUnitType type) const = 0;

Parameters

type: The type of intermediate result unit to check.

Return

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

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version (2.2.0)
  • Version 2.x
    • Version 2.0.30
    • Version 2.0.20
    • Version 2.0.10
    • Version 2.0.0
Change +
© 2003–2024 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support