Inscoper::ConnectionDescription

ConnectionDescription class provides connection information coming from the device controller. More...

#include <ConnectionDescription.h>

Public Functions

	Name
	ConnectionDescription() Default constructor.
unsigned short	getTag() const Get the tag of the connection.
void	setTag(unsigned short tag) Set the tag of the connection.
Inscoper::EConnectionTypeDesc	getType() const Get the type of the connection.
void	setType(Inscoper::EConnectionTypeDesc type) Set the type of the connection.
const std::string &	getDescription() const Get the description of the connection.
void	setDescription(const std::string & description) Set the description of the connection.

Detailed Description

class Inscoper::ConnectionDescription;

ConnectionDescription class provides connection information coming from the device controller.

This class encapsulates details about a device connection, such as its tag, type, and a textual description, as reported by the device controller.

Public Functions Documentation

function ConnectionDescription

ConnectionDescription()

Default constructor.

Initializes a new instance of the ConnectionDescription class.

function getTag

unsigned short getTag() const

Get the tag of the connection.

Return: The tag of the connection

Retrieves the unique tag of the connection.

function setTag

void setTag(
    unsigned short tag
)

Set the tag of the connection.

Parameters:

• tag : The tag of the connection

Sets the unique tag of the connection.

function getType

Inscoper::EConnectionTypeDesc getType() const

Get the type of the connection.

Return: The type of the connection

Retrieves the type of the connection (e.g., Serial, USB).

function setType

void setType(
    Inscoper::EConnectionTypeDesc type
)

Set the type of the connection.

Parameters:

• type : The type of the connection

Sets the type of the connection.

function getDescription

const std::string & getDescription() const

Get the description of the connection.

Return: The description of the connection

Retrieves the textual description of the connection.

function setDescription

void setDescription(
    const std::string & description
)

Set the description of the connection.

Parameters:

• description : The description of the connection

Sets the textual description of the connection.

---

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