Solar
Public Member Functions | List of all members
SolAR::api::input::devices::IDevice Class Referenceabstract

Manage any kind of device. UUID: d73c7b34-f6af-48f3-b65d-37a047929f4b More...

#include <IDevice.h>

Inheritance diagram for SolAR::api::input::devices::IDevice:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::input::devices::IDevice:
Collaboration graph
[legend]

Public Member Functions

 IDevice ()=default
 Specify the IDevice constructor class.
 
virtual ~IDevice () override=default
 Specify the IDevice destructor class.
 
virtual FrameworkReturnCode start ()=0
 Start the acquisition device referenced by its device_id. More...
 
virtual FrameworkReturnCode stop ()=0
 Stop the acquisition device. More...
 

Detailed Description

Manage any kind of device. UUID: d73c7b34-f6af-48f3-b65d-37a047929f4b

This class describes the interface of a capture device.

Member Function Documentation

◆ start()

virtual FrameworkReturnCode SolAR::api::input::devices::IDevice::start ( )
pure virtual

Start the acquisition device referenced by its device_id.

Returns
FrameworkReturnCode::SUCCESS if sucessful, eiher FrameworkRetunrnCode::_ERROR.

◆ stop()

virtual FrameworkReturnCode SolAR::api::input::devices::IDevice::stop ( )
pure virtual

Stop the acquisition device.

Returns
FrameworkReturnCode::SUCCESS if sucessful, eiher FrameworkRetunrnCode::_ERROR.

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