Skip to content

Commit 1fd242b

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit 5ab48f68
1 parent a3b4a8b commit 1fd242b

File tree

6 files changed

+446
-1
lines changed

6 files changed

+446
-1
lines changed

‎_includes/inherited-methods/intermediate-result-unit-v2.6.1000.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
The following methods are inherited from class [`CIntermediateResultUnit`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html).
3+
4+
| Method | Description |
5+
|----------------------|-------------|
6+
| [`GetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Gets the hash ID of the unit.|
7+
| [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Gets the hash ID of the original image. |
8+
| [`GetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) | Gets the image tag of the original image. |
9+
| [`GetType`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettype) | Gets the type of the intermediate result unit. |
10+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
11+
| [`SetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#sethashid) | Sets the hash ID of the unit. |
12+
| [`SetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagehashid) | Sets the hash ID of the original image. |
13+
| [`SetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagetag) | Sets the image tag of the original image. |
14+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#retain) | Increases the reference count of the unit. |
15+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#release) | Decreases the reference count of the unit. |
16+
| [`GetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) | Gets the transformation matrix via [`TransformMatrixType`]({{site.dcvb_enumerations}}core/transform-matrix-type.html?src=cpp&&lang=cpp). |
17+
| [`SetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#settransformmatrix) | Sets the transformation matrix via [`TransformMatrixType`]({{site.dcvb_enumerations}}core/transform-matrix-type.html?src=cpp&&lang=cpp). |
18+

‎programming/cplusplus/api-reference/core/basic-structures/captured-result-item-v2.6.1000.md‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
layout: default-layout
3+
title: class CCapturedResultItem - Dynamsoft Core Module C++ Edition API Reference
4+
description: This page shows the C++ edition of the class CCapturedResultItem in Dynamsoft Core Module.
5+
keywords: captured result item, c++
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# CCapturedResultItem
10+
11+
The CCapturedResultItem class represents an item in a captured result. It is an abstract base class with multiple subclasses, each representing a different type of captured item such as barcode, text line, detected quad, normalized image, raw image, parsed item, etc.
12+
13+
## Definition
14+
15+
*Namespace:* dynamsoft::basic_structures
16+
17+
*Assembly:* DynamsoftCore
18+
19+
```cpp
20+
class CCapturedResultItem
21+
```
22+
23+
## Methods Summary
24+
25+
| Method | Description|
26+
|--------------------------------|------------|
27+
| [`~CCapturedResultItem`](#ccapturedresultitem-destructor) | This is the class destructor. |
28+
| [`GetType`](#gettype) | Gets the type of the captured result item. |
29+
| [`GetReferenceItem`](#getreferenceitem) | Gets a pointer to the referenced item in the captured result. |
30+
| [`GetTargetROIDefName`](#gettargetroidefname) | Gets the name of the target ROI definition. |
31+
| [`GetTaskName`](#gettaskname) | Gets the name of the task. |
32+
| [`Retain`](#retain) | Increases the reference count of the `CCapturedResultItem` object. |
33+
| [`Release`](#release) | Decreases the reference count of the `CCapturedResultItem` object. |
34+
| [`Clone`](#clone) | Clone the captured result item. |
35+
36+
### CCapturedResultItem Destructor
37+
38+
This is the class destructor.
39+
40+
```cpp
41+
virtual ~CCapturedResultItem(){};
42+
```
43+
44+
### GetType
45+
46+
Gets the type of the captured result item.
47+
48+
```cpp
49+
virtual CapturedResultItemType GetType() const
50+
```
51+
52+
**Return value**
53+
54+
Returns the type of the captured result item.
55+
56+
**See Also**
57+
58+
[CapturedResultItemType]({{ site.dcvb_enumerations }}core/captured-result-item-type.html?src=cpp&&lang=cpp)
59+
60+
### GetReferenceItem
61+
62+
Gets a pointer to the referenced item in the captured result item.
63+
64+
```cpp
65+
virtual const CCapturedResultItem* GetReferenceItem() const
66+
```
67+
68+
**Return value**
69+
70+
Returns a pointer to the referenced item in the captured result item. You are not required to release the memory pointed to by the returned pointer.
71+
72+
**See Also**
73+
74+
[CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html)
75+
76+
### GetTargetROIDefName
77+
78+
Gets the name of the target ROI definition.
79+
80+
```cpp
81+
virtual const char* GetTargetROIDefName() const = 0;
82+
```
83+
84+
**Return value**
85+
86+
Returns the name of the target ROI definition.
87+
88+
### GetTaskName
89+
90+
Gets the name of the task.
91+
92+
```cpp
93+
virtual const char* GetTaskName() const = 0;
94+
```
95+
96+
**Return value**
97+
98+
Returns the name of the task.
99+
100+
### Retain
101+
102+
Increases the reference count of the `CCapturedResultItem` object.
103+
104+
```cpp
105+
virtual CCapturedResultItem* Retain() = 0;
106+
```
107+
108+
**Return value**
109+
110+
Returns the object of `CCapturedResultItem` with its reference count incremented.
111+
112+
**Remarks**
113+
114+
Don't forget to invoke the `Release` method when you no longer need the object.
115+
116+
### Release
117+
118+
Decreases the reference count of the `CCapturedResultItem` object.
119+
120+
```cpp
121+
virtual void Release() = 0;
122+
```
123+
124+
### Clone
125+
126+
Clones the captured result item.
127+
128+
```cpp
129+
virtual CCapturedResultItem* Clone() const = 0;
130+
```
131+
132+
**Return value**
133+
134+
Returns a pointer to a copy of the captured result item.
135+
136+
**Remarks**
137+
138+
Don't forget to invoke the `Release` method when you no longer need the object.

‎programming/cplusplus/api-reference/core/basic-structures/image-source-error-listener-v2.6.1000.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: default-layout
3+
title: class CImageSourceErrorListener - Dynamsoft Capture Vision C++ Edition API Reference
4+
description: This page shows the C++ edition of the class CImageSourceErrorListener in Core Module.
5+
keywords: imagesource error listener, c++
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# CImageSourceErrorListener
11+
12+
The `CImageSourceErrorListener` class is an abstract base class for receiving error notifications from an image source.
13+
14+
## Definition
15+
16+
*Namespace:* dynamsoft::basic_structures
17+
18+
*Assembly:* DynamsoftCore
19+
20+
```cpp
21+
class CImageSourceErrorListener
22+
```
23+
24+
## Methods Summary
25+
26+
| Method | Description |
27+
| ------ | ----------- |
28+
| [`OnErrorReceived`](#onerrorreceived) | Called when an error is received from the image source. |
29+
30+
### OnErrorReceived
31+
32+
Called when an error is received from the image source.
33+
34+
```cpp
35+
virtual void OnErrorReceived(int errorCode, const char* errorMessage)
36+
```
37+
38+
**Parameters**
39+
40+
`[in] errorCode` The integer error code indicating the type of error.
41+
42+
`[in] errorMessage` A C-style string containing the error message providing additional information about the error.
43+
44+
**See Also**
45+
46+
[ErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?src=cpp&&lang=cpp)

‎programming/cplusplus/api-reference/core/intermediate-results/observed-parameters-v2.6.1000.md‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
layout: default-layout
3+
title: class CObservationParameters - Dynamsoft Core Module C++ Edition API Reference
4+
description: This page shows the C++ edition of the class CObservationParameters in Dynamsoft Core Module.
5+
keywords: intermediate result, c++
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# CObservationParameters
10+
11+
The `CObservationParameters` class is used to set filter conditions for the `CIntermediateResultReceiver`, so that only intermediate results meeting specific conditions will be called back.
12+
13+
## Definition
14+
15+
*Namespace:* dynamsoft::intermediate_results
16+
17+
*Assembly:* DynamsoftCore
18+
19+
```cpp
20+
class CObservationParameters
21+
```
22+
23+
## Methods Summary
24+
25+
| Method | Description |
26+
|----------------------|-------------|
27+
| [`SetObservedResultUnitTypes`](#setobservedresultunittypes) | Sets the types of intermediate result units that have been observed.|
28+
| [`GetObservedResultUnitTypes`](#getobservedresultunittypes) | Gets the types of intermediate result units that have been observed. |
29+
| [`IsResultUnitTypeObserved`](#isresultunittypeobserved) | Determines whether the specified result unit type was observed. |
30+
| [`AddObservedTask`](#addobservedtask) | Adds observed task name to be notified when relevant results are available. |
31+
| [`RemoveObservedTask`](#removeobservedtask) | Remove the observed task name so that intermediate results generated by the task are not notified. |
32+
| [`IsTaskObserved`](#istaskobserved) | Determines whether the specified task was observed. |
33+
| [`SetResultUnitTypesOnlyForInput`](#setresultunittypesonlyforinput) | Set the type of intermediate result unit that indicates skipping default calculations and replacing with input data units. |
34+
| [`GetResultUnitTypesOnlyForInput`](#getresultunittypesonlyforinput) | Gets the type of intermediate result unit that indicates skipping default calculations and replacing with input data units. |
35+
| [`IsResultUnitTypeOnlyForInput`](#isresultunittypeonlyforinput) | Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units. |
36+
37+
### SetObservedResultUnitTypes
38+
39+
Sets the types of intermediate result units that have been observed.
40+
41+
```cpp
42+
void SetObservedResultUnitTypes(unsigned long long types)
43+
```
44+
45+
**Parameters**
46+
47+
`[in] types` The observed types of intermediate result units.
48+
49+
**See Also**
50+
51+
[IntermediateResultUnitType]({{ site.dcvb_enumerations }}core/intermediate-result-unit-type.html?src=cpp&&lang=cpp)
52+
53+
### GetObservedResultUnitTypes
54+
55+
Gets the types of intermediate result units that have been observed.
56+
57+
```cpp
58+
unsigned long long GetObservedResultUnitTypes() const
59+
```
60+
61+
**Return value**
62+
63+
The observed types of intermediate result units.
64+
65+
**See Also**
66+
67+
[IntermediateResultUnitType]({{ site.dcvb_enumerations }}core/intermediate-result-unit-type.html?src=cpp&&lang=cpp)
68+
69+
### IsResultUnitTypeObserved
70+
71+
Determines whether the specified result unit type was observed.
72+
73+
```cpp
74+
bool IsResultUnitTypeObserved(IntermediateResultUnitType type) const
75+
```
76+
77+
**Return value**
78+
79+
Returns a boolean value indicating whether the specified result unit type was observed.
80+
81+
**See Also**
82+
83+
[IntermediateResultUnitType]({{ site.dcvb_enumerations }}core/intermediate-result-unit-type.html?src=cpp&&lang=cpp)
84+
85+
### AddObservedTask
86+
87+
Adds observed task name to be notified when relevant results are available.
88+
89+
```cpp
90+
void AddObservedTask(const char* taskName)
91+
```
92+
93+
**Parameters**
94+
95+
`[in] taskName` The specified task name.
96+
97+
### RemoveObservedTask
98+
99+
Remove the observed task name so that intermediate results generated by the task are not notified.
100+
101+
```cpp
102+
void RemoveObservedTask(const char* taskName)
103+
```
104+
105+
**Parameters**
106+
107+
`[in] taskName` The specified task name.
108+
109+
### IsTaskObserved
110+
111+
Determines whether the specified task was observed.
112+
113+
```cpp
114+
bool IsTaskObserved(const char* taskName) const
115+
```
116+
117+
**Parameters**
118+
119+
`[in] taskName` The specified task name.
120+
121+
**Return value**
122+
123+
Returns a boolean value indicating whether the specified task was observed.
124+
125+
### SetResultUnitTypesOnlyForInput
126+
127+
Set the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
128+
129+
```cpp
130+
virtual void SetResultUnitTypesOnlyForInput(unsigned long long types) = 0;
131+
```
132+
133+
**Parameters**
134+
135+
`types`: The type of intermediate result unit that serves as the combination value of `IntermediateResultUnitType`.
136+
137+
### GetResultUnitTypesOnlyForInput
138+
139+
Gets the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
140+
141+
```cpp
142+
virtual unsigned long long GetResultUnitTypesOnlyForInput() const = 0;
143+
```
144+
145+
**Return**
146+
147+
Returns the type of intermediate result unit that serves as the combination value of `IntermediateResultUnitType`.
148+
149+
### IsResultUnitTypeOnlyForInput
150+
151+
Determines whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.
152+
153+
```cpp
154+
virtual bool IsResultUnitTypeOnlyForInput(IntermediateResultUnitType type) const = 0;
155+
```
156+
157+
**Parameters**
158+
159+
`type`: The type of intermediate result unit to check.
160+
161+
**Return**
162+
163+
Returns a boolean value indicating whether the specified type of intermediate result unit indicates skipping default calculations and replacing with input data units.

0 commit comments

Comments
 (0)