Inscoper::CustomDriverDescription¶

CustomDriverDescription class provides information for custom drivers. More...

#include <CustomDriverDescription.h>

Inherits from Inscoper::ExternalDriverDescription, Inscoper::DriverDescription

Public Functions¶

	Name
	CustomDriverDescription() Default constructor.
virtual Inscoper::EDriverType	getDriverType() const override Get the driver type.
virtual bool	isEqual(const DriverDescription & other) const override Checks whether this driver description is identical to another one.
const std::string &	getDriverName() const Get the driver name.
void	setDriverName(const std::string & driverName) Set the driver name.

Additional inherited members¶

Public Functions inherited from Inscoper::ExternalDriverDescription

	Name
	ExternalDriverDescription() Default constructor.
Inscoper::EDeviceType	getDeviceType() const Get the device type.
void	setDeviceType(Inscoper::EDeviceType deviceType) Set the device type.

Public Functions inherited from Inscoper::DriverDescription

	Name
	DriverDescription() =default Default constructor.
virtual	~DriverDescription() =default Virtual destructor.

Detailed Description¶

class Inscoper::CustomDriverDescription;

CustomDriverDescription class provides information for custom drivers.

Note: This class is non-copyable and non-movable.

This class extends ExternalDriverDescription to provide specific details for custom drivers.

Public Functions Documentation¶

function CustomDriverDescription¶

CustomDriverDescription()

Default constructor.

Initializes a new instance of the CustomDriverDescription class.

function getDriverType¶

virtual Inscoper::EDriverType getDriverType() const override

Get the driver type.

Return: The driver type

Reimplements: Inscoper::ExternalDriverDescription::getDriverType

Retrieves the specific type of driver (CUSTOM_DRIVER).

function isEqual¶

virtual bool isEqual(
    const DriverDescription & other
) const override

Checks whether this driver description is identical to another one.

Parameters:

other The description to compare against

Return: True if the configurations are identical, false otherwise

Reimplements: Inscoper::DriverDescription::isEqual

This method determines if two driver descriptions represent the same configuration. The application uses this to avoid unnecessary driver restarts when the configuration is unchanged.

function getDriverName¶

const std::string & getDriverName() const

Get the driver name.

Return: The driver name

Retrieves the name of the custom driver.

function setDriverName¶

void setDriverName(
    const std::string & driverName
)

Set the driver name.

Parameters:

driverName : The driver name

Sets the name of the custom driver.

Updated on 2026-06-23 at 10:35:19 +0200