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
Namespace: Dynamsoft.Core.intermediate_results
public class ObservationParameters : IDisposable
Methods
| 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 |
Sets 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(ulong types)
Parameters
[in] types The observed types of intermediate result units.
See Also
EnumIntermediateResultUnitType
GetObservedResultUnitTypes
Gets the types of intermediate result units that have been observed.
ulong GetObservedResultUnitTypes()
Return value
The observed types of intermediate result units.
See Also
EnumIntermediateResultUnitType
IsResultUnitTypeObserved
Determines whether the specified result unit type was observed.
bool IsResultUnitTypeObserved(EnumIntermediateResultUnitType type)
Parameters
[in] type The result unit type to check.
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
[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(string taskName)
Parameters
[in] taskName The specified task name.
IsTaskObserved
Determines whether the specified task was observed.
bool IsTaskObserved(string taskName)
Parameters
[in] taskName The specified task name.
Return value
Returns a boolean value indicating whether the specified task was observed.
SetResultUnitTypesOnlyForInput
Sets the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
void SetResultUnitTypesOnlyForInput(ulong types)
Parameters
types: The type of intermediate result unit that serves as the combination value of EnumIntermediateResultUnitType.
See Also
EnumIntermediateResultUnitType
GetResultUnitTypesOnlyForInput
Gets the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
ulong GetResultUnitTypesOnlyForInput()
Return
Returns the type of intermediate result unit that serves as the combination value of EnumIntermediateResultUnitType.
See Also
EnumIntermediateResultUnitType
IsResultUnitTypeOnlyForInput
Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.
bool IsResultUnitTypeOnlyForInput(EnumIntermediateResultUnitType type)
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.
See Also
Yes
No