Skip to content

External matching result

ExternalMatchingResult

Bases: SharedMatchingResult, IApiInterfaceImplementation

Representation of the matching result, designed to be used by the main process. For this reason, it is essential that this class is picklable.

Source code in src/officialeye/_internal/template/external_matching_result.py
class ExternalMatchingResult(SharedMatchingResult, IApiInterfaceImplementation):
    """
    Representation of the matching result, designed to be used by the main process.
    For this reason, it is essential that this class is picklable.
    """

    def __init__(self, internal_matching_result: InternalMatchingResult, external_template: ExternalTemplate, /):
        super().__init__(internal_matching_result.template)

        self._template = external_template

    @property
    def template(self) -> ExternalTemplate:
        return self._template

    def set_api_context(self, context: Context, /) -> None:
        self._template.set_api_context(context)

    def clear_api_context(self) -> None:
        self._template.clear_api_context()