ConnectionConfig¶
Bases: object
Base class for connection configuration.
Notes: This class is non-copyable and non-movable.
This abstract class defines the interface for configuring different types of connections (e.g., USB, Ethernet) used by devices.
fromXML(connectionNode)
¶
Provide connection information from the XML connection node.
Populates the connection configuration from the provided XML connection node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connectionNode
|
XMLNode
|
The XML connection node containing connection information |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
if an error occurred |
toXML(xmlParent)
¶
Export connection information in an XML node attached to the parent XML node.
Serializes the connection configuration to the specified parent XML node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xmlParent
|
XMLNode
|
The parent XML node |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
if an error occurred |
getType()
¶
Return the type of the current connection.
Retrieves the specific type of connection configuration.
Returns:
| Type | Description |
|---|---|
int
|
The type of the current connection |
getTag()
¶
Get the tag of the current connection.
Retrieves the tag identifier associated with this connection.
Returns:
| Type | Description |
|---|---|
int
|
The current connection tag |
setTag(tag)
¶
Set the tag of the current connection.
Assigns a tag identifier to this connection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tag
|
int
|
The current connection tag |
required |