Solar
Public Member Functions | List of all members
SolAR::api::pipeline::IPipeline Class Referenceabstract

Abstract class defining a generic pipeline object. UUID: b636f583-4f1e-41c9-94da-9d0eac82aa02 More...

#include <IPipeline.h>

Inheritance diagram for SolAR::api::pipeline::IPipeline:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::pipeline::IPipeline:
Collaboration graph
[legend]

Public Member Functions

virtual FrameworkReturnCode init ()=0
 Initialization of the pipeline. More...
 
virtual FrameworkReturnCode start ()=0
 Start the pipeline. More...
 
virtual FrameworkReturnCode stop ()=0
 Stop the pipeline. More...
 

Detailed Description

Abstract class defining a generic pipeline object. UUID: b636f583-4f1e-41c9-94da-9d0eac82aa02

This class defines a generic pipeline interface.

Member Function Documentation

◆ init()

virtual FrameworkReturnCode SolAR::api::pipeline::IPipeline::init ( )
pure virtual

Initialization of the pipeline.

Returns
FrameworkReturnCode::SUCCESS if the init succeed, else FrameworkReturnCode::_ERROR

Implemented in SolAR::api::pipeline::IAsyncRelocalizationPipeline.

◆ start()

virtual FrameworkReturnCode SolAR::api::pipeline::IPipeline::start ( )
pure virtual

Start the pipeline.

Returns
FrameworkReturnCode::SUCCESS if the stard succeed, else FrameworkReturnCode::_ERROR

◆ stop()

virtual FrameworkReturnCode SolAR::api::pipeline::IPipeline::stop ( )
pure virtual

Stop the pipeline.

Returns
FrameworkReturnCode::SUCCESS if the stop succeed, else FrameworkReturnCode::_ERROR

The documentation for this class was generated from the following file: