Inscoper::InscoperBoxDriverDescription¶

The InscoperBoxDriverDescription class provides information for devices supported by the device controller. More...

#include <InscoperBoxDriverDescription.h>

Inherits from Inscoper::DriverDescription

Public Functions¶

	Name
	InscoperBoxDriverDescription() Default constructor.
unsigned int	getHardwareId() const Get the device hardware ID.
void	setHardwareId(unsigned int hardwareId) Set the device hardware ID.
const std::string &	getProjectName() const Get the internal reference of the device.
void	setProjectName(const std::string & projectName) Set the internal reference of the device.
const std::string &	getFunctionProjectName() const Get the internal reference of the function.
void	setFunctionProjectName(const std::string & functionProjectName) Set the internal reference of the function.
unsigned int	getCrc32() const Get the CRC32 of the device.
void	setCrc32(unsigned int crc32) Set the CRC32 of the device.
void	addConnectionDescription(const Inscoper::ConnectionDescriptionPtr & connectionDescription) Add a connection to the list.
void	setConnectionDescriptionList(const std::vector< Inscoper::ConnectionDescriptionPtr > & connectionDescriptionList) Set the list of connection.
const std::vector< Inscoper::ConnectionDescriptionPtr > &	getConnectionDescriptionList() const Get the list of connections.
Inscoper::ConnectionDescriptionPtr	getConnectionDescription(unsigned short tag) Get the connection corresponding to the given tag.

Additional inherited members¶

Public Functions inherited from Inscoper::DriverDescription

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

Detailed Description¶

class Inscoper::InscoperBoxDriverDescription;

The InscoperBoxDriverDescription class provides information for devices supported by the device controller.

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

This class describes the driver for a device supported by the controller, including its hardware identification, firmware CRC, and a list of available connections (e.g., TTL, PWM, Analog).

Public Functions Documentation¶

function InscoperBoxDriverDescription¶

InscoperBoxDriverDescription()

Default constructor.

Initializes a new instance of the InscoperBoxDriverDescription class.

function getHardwareId¶

unsigned int getHardwareId() const

Get the device hardware ID.

Return: The device hardware ID

Retrieves the unique hardware identifier of the device associated with this driver.

function setHardwareId¶

void setHardwareId(
    unsigned int hardwareId
)

Set the device hardware ID.

Parameters:

hardwareId : The device hardware ID

Sets the unique hardware identifier of the device associated with this driver.

function getProjectName¶

const std::string & getProjectName() const

Get the internal reference of the device.

Return: The internal reference of the device

Retrieves the internal reference of the device in the firmware.

function setProjectName¶

void setProjectName(
    const std::string & projectName
)

Set the internal reference of the device.

Parameters:

projectName : The internal reference of the device

Sets the internal reference of the device in the firmware.

function getFunctionProjectName¶

const std::string & getFunctionProjectName() const

Get the internal reference of the function.

Return: The internal reference of the function

Retrieves the internal reference of the function in the firmware.

function setFunctionProjectName¶

void setFunctionProjectName(
    const std::string & functionProjectName
)

Set the internal reference of the function.

Parameters:

functionProjectName : The internal reference of the function

Sets the internal reference of the function in the firmware.

function getCrc32¶

unsigned int getCrc32() const

Get the CRC32 of the device.

Return: The CRC32 of the device

Retrieves the CRC32 of the device driver.

function setCrc32¶

void setCrc32(
    unsigned int crc32
)

Set the CRC32 of the device.

Parameters:

crc32 : The CRC32 of the device

Sets the CRC32 of the device driver.

function addConnectionDescription¶

void addConnectionDescription(
    const Inscoper::ConnectionDescriptionPtr & connectionDescription
)

Add a connection to the list.

Parameters:

connectionDescription : The connection to add

Appends a connection to the connections list.

function setConnectionDescriptionList¶

void setConnectionDescriptionList(
    const std::vector< Inscoper::ConnectionDescriptionPtr > & connectionDescriptionList
)

Set the list of connection.

Parameters:

connectionDescriptionList : The list of connections

Replaces the current list of supported connections.

function getConnectionDescriptionList¶

const std::vector< Inscoper::ConnectionDescriptionPtr > & getConnectionDescriptionList() const

Get the list of connections.

Return: The ConnectionDescription list

Retrieves the list of connections supported by this driver.

function getConnectionDescription¶

Inscoper::ConnectionDescriptionPtr getConnectionDescription(
    unsigned short tag
)

Get the connection corresponding to the given tag.

Parameters:

tag : The ConnectionDescription tag

Return: The ConnectionDescription if found, otherwise nullptr

Retrieves a specific connection by its tag.

Updated on 2026-04-02 at 10:55:36 +0200