Skip to content

ConnectionDescription

Bases: object

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.

__init__()

Default constructor.

Initializes a new instance of the ConnectionDescription class.

getTag()

Get the tag of the connection.

Retrieves the unique tag of the connection.

Returns:

Type Description
int

The tag of the connection

setTag(tag)

Set the tag of the connection.

Sets the unique tag of the connection.

Parameters:

Name Type Description Default
tag int

The tag of the connection

required

getType()

Get the type of the connection.

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

Returns:

Type Description
int

The type of the connection

setType(type)

Set the type of the connection.

Sets the type of the connection.

Parameters:

Name Type Description Default
type int

The type of the connection

required

getDescription()

Get the description of the connection.

Retrieves the textual description of the connection.

Returns:

Type Description
str

The description of the connection

setDescription(description)

Set the description of the connection.

Sets the textual description of the connection.

Parameters:

Name Type Description Default
description string

The description of the connection

required