robokudo.descriptors.analysis_engines.query_complex

Classes

AnalysisEngine

Protocol defining the interface for Analysis Engines.

Module Contents

class robokudo.descriptors.analysis_engines.query_complex.AnalysisEngine

Bases: robokudo.analysis_engine.AnalysisEngineInterface

Protocol defining the interface for Analysis Engines.

This interface must be implemented by all Analysis Engines in RoboKudo. Each Analysis Engine provides a behavior tree implementation for a specific task or pipeline. The RoboKudo runner will load and execute these implementations.

Warning

Do not instantiate this class directly. Instead, create a subclass that implements this interface.

See robokudo.descriptors.analysis_engines for example implementations.

name()

Get the name of this Analysis Engine.

Returns:

The unique name identifying this Analysis Engine

Return type:

str

implementation()

Create a pipeline which responds to a query