ScanbotSDKGenericDocument.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/GenericDocument.yaml
 
#pragma once
#ifndef SCANBOTSDK_GENERICDOCUMENT_H
#define SCANBOTSDK_GENERICDOCUMENT_H
 
 
#include <ScanbotSDKImage.h>
#include <ScanbotSDKTypes.h>
#include <generic_document/ScanbotSDKCommonFieldType.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef struct scanbotsdk_ocr_result_t scanbotsdk_ocr_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_result_create(
    scanbotsdk_u8string_ref_t text,
    double confidence,
    scanbotsdk_ocr_result_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_result_free(scanbotsdk_ocr_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_result_get_text(scanbotsdk_ocr_result_t* self, scanbotsdk_u8string_ref_t* text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_result_get_confidence(scanbotsdk_ocr_result_t* self, double* confidence);
 

typedef enum scanbotsdk_field_validation_status_t {

    SCANBOTSDK_FIELD_VALIDATION_STATUS_INVALID = 0,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_OBSTRUCTED = 1,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_NONE = 2,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_CONFIRMED = 3,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_INFERRED = 4,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_VALID = 5,

    SCANBOTSDK_FIELD_VALIDATION_STATUS_IGNORED = 6,
 
} scanbotsdk_field_validation_status_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_validation_status_t_to_string(scanbotsdk_field_validation_status_t value, const char** result);

typedef enum scanbotsdk_field_data_format_t {

    SCANBOTSDK_FIELD_DATA_FORMAT_ISO_DATE = 0,

    SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_ALPHA_2 = 1,

    SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_ALPHA_3 = 2,

    SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_NUMERIC = 3,

    SCANBOTSDK_FIELD_DATA_FORMAT_ISO_COUNTRY_NAME = 4,

    SCANBOTSDK_FIELD_DATA_FORMAT_GENDER = 5,
 
} scanbotsdk_field_data_format_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_data_format_t_to_string(scanbotsdk_field_data_format_t value, const char** result);

typedef struct scanbotsdk_field_parsed_data_t scanbotsdk_field_parsed_data_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_parsed_data_create(
    scanbotsdk_field_data_format_t type,
    scanbotsdk_u8string_ref_t value,
    scanbotsdk_field_parsed_data_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_parsed_data_free(scanbotsdk_field_parsed_data_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_parsed_data_get_type(scanbotsdk_field_parsed_data_t* self, scanbotsdk_field_data_format_t* type);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_parsed_data_get_value(scanbotsdk_field_parsed_data_t* self, scanbotsdk_u8string_ref_t* value);
 

typedef struct scanbotsdk_field_type_t scanbotsdk_field_type_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_create(
    scanbotsdk_u8string_ref_t name,
    scanbotsdk_u8string_ref_t full_name,
    scanbotsdk_u8string_ref_t normalized_name,
    scanbotsdk_common_field_type_t* common_type,
    int* list_index,
    scanbotsdk_field_type_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_create_with_defaults(
    scanbotsdk_u8string_ref_t name,
    scanbotsdk_u8string_ref_t full_name,
    scanbotsdk_u8string_ref_t normalized_name,
    scanbotsdk_common_field_type_t* common_type,
    scanbotsdk_field_type_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_free(scanbotsdk_field_type_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_get_name(scanbotsdk_field_type_t* self, scanbotsdk_u8string_ref_t* name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_get_full_name(scanbotsdk_field_type_t* self, scanbotsdk_u8string_ref_t* full_name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_get_normalized_name(scanbotsdk_field_type_t* self, scanbotsdk_u8string_ref_t* normalized_name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_get_common_type(scanbotsdk_field_type_t* self, scanbotsdk_common_field_type_t** common_type);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_type_get_list_index(scanbotsdk_field_type_t* self, int** list_index);
 

typedef struct scanbotsdk_field_t scanbotsdk_field_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_create(
    scanbotsdk_field_type_t* type,
    scanbotsdk_ocr_result_t* value,
    double confidence_weight,
    scanbotsdk_image_t* image,
    scanbotsdk_pointf_t* polygon_in_root,
    size_t polygon_in_root_size,
    scanbotsdk_field_validation_status_t validation_status,
    scanbotsdk_field_parsed_data_t** parsed_data,
    size_t parsed_data_size,
    scanbotsdk_field_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_create_with_defaults(
    scanbotsdk_field_type_t* type,
    scanbotsdk_ocr_result_t* value,
    scanbotsdk_pointf_t* polygon_in_root,
    size_t polygon_in_root_size,
    scanbotsdk_field_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_free(scanbotsdk_field_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_type(scanbotsdk_field_t* self, scanbotsdk_field_type_t** type);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_value(scanbotsdk_field_t* self, scanbotsdk_ocr_result_t** value);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_confidence_weight(scanbotsdk_field_t* self, double* confidence_weight);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_image(scanbotsdk_field_t* self, scanbotsdk_image_t** image);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_polygon_in_root(scanbotsdk_field_t* self, scanbotsdk_pointf_t** polygon_in_root);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_polygon_in_root_size(scanbotsdk_field_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_validation_status(scanbotsdk_field_t* self, scanbotsdk_field_validation_status_t* validation_status);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_parsed_data(scanbotsdk_field_t* self, scanbotsdk_field_parsed_data_t** parsed_data, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_get_parsed_data_size(scanbotsdk_field_t* self, size_t* size);
 

typedef struct scanbotsdk_generic_document_type_t scanbotsdk_generic_document_type_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_create(
    scanbotsdk_u8string_ref_t name,
    scanbotsdk_u8string_ref_t full_name,
    scanbotsdk_u8string_ref_t normalized_name,
    int* list_index,
    scanbotsdk_generic_document_type_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_create_with_defaults(
    scanbotsdk_u8string_ref_t name,
    scanbotsdk_u8string_ref_t full_name,
    scanbotsdk_u8string_ref_t normalized_name,
    scanbotsdk_generic_document_type_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_free(scanbotsdk_generic_document_type_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_get_name(scanbotsdk_generic_document_type_t* self, scanbotsdk_u8string_ref_t* name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_get_full_name(scanbotsdk_generic_document_type_t* self, scanbotsdk_u8string_ref_t* full_name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_get_normalized_name(scanbotsdk_generic_document_type_t* self, scanbotsdk_u8string_ref_t* normalized_name);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_type_get_list_index(scanbotsdk_generic_document_type_t* self, int** list_index);
 

typedef struct scanbotsdk_generic_document_t scanbotsdk_generic_document_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_create(
    scanbotsdk_generic_document_type_t* type,
    scanbotsdk_field_t** fields,
    size_t fields_size,
    scanbotsdk_generic_document_t** children,
    size_t children_size,
    scanbotsdk_pointf_t* quad,
    size_t quad_size,
    scanbotsdk_pointf_t* quad_in_root,
    size_t quad_in_root_size,
    scanbotsdk_image_t* crop,
    double confidence,
    double confidence_weight,
    scanbotsdk_generic_document_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_create_with_defaults(
    scanbotsdk_generic_document_type_t* type,
    scanbotsdk_field_t** fields,
    size_t fields_size,
    scanbotsdk_generic_document_t** children,
    size_t children_size,
    scanbotsdk_pointf_t* quad,
    size_t quad_size,
    scanbotsdk_pointf_t* quad_in_root,
    size_t quad_in_root_size,
    scanbotsdk_generic_document_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_free(scanbotsdk_generic_document_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_type(scanbotsdk_generic_document_t* self, scanbotsdk_generic_document_type_t** type);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_fields(scanbotsdk_generic_document_t* self, scanbotsdk_field_t** fields, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_fields_size(scanbotsdk_generic_document_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_children(scanbotsdk_generic_document_t* self, scanbotsdk_generic_document_t** children, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_children_size(scanbotsdk_generic_document_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_quad(scanbotsdk_generic_document_t* self, scanbotsdk_pointf_t** quad);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_quad_size(scanbotsdk_generic_document_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_quad_in_root(scanbotsdk_generic_document_t* self, scanbotsdk_pointf_t** quad_in_root);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_quad_in_root_size(scanbotsdk_generic_document_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_crop(scanbotsdk_generic_document_t* self, scanbotsdk_image_t** crop);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_confidence(scanbotsdk_generic_document_t* self, double* confidence);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_generic_document_get_confidence_weight(scanbotsdk_generic_document_t* self, double* confidence_weight);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_GENERICDOCUMENT_H */