xentara-utils v1.2.1
Xentara utilities library
Loading...
Searching...
No Matches
xentara::utils::io::DeviceBase Class Referenceabstract

Common base class for input and output devices. More...

#include <io/DeviceBase.hpp>

+ Inheritance diagram for xentara::utils::io::DeviceBase:

Public Member Functions

virtual ~DeviceBase () noexcept(false)=0
 Virtual, throwing destructor.
 
auto deviceDescription () const -> std::string
 Get a description of the device.
 

Protected Member Functions

virtual auto doGetDeviceDescription () const -> std::string=0
 Called by the framework to get a description of the device.
 

Detailed Description

Common base class for input and output devices.

Constructor & Destructor Documentation

◆ ~DeviceBase()

virtual xentara::utils::io::DeviceBase::~DeviceBase ( )
pure virtual

Virtual, throwing destructor.

Member Function Documentation

◆ deviceDescription()

auto xentara::utils::io::DeviceBase::deviceDescription ( ) const -> std::string

Get a description of the device.

Returns
A description of the device suitable for debug outputs

◆ doGetDeviceDescription()

virtual auto xentara::utils::io::DeviceBase::doGetDeviceDescription ( ) const -> std::string
protectedpure virtual

Called by the framework to get a description of the device.

Returns
Must return a description of the device, suitable for debug outputs