Skip to content

AdvancedConnectionConfig

Bases: ConnectionConfig

AdvancedConnectionConfig class provides required information for most connections: Analog, TTL, PWM, RS232/UART.

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

This class extends ConnectionConfig to include specific configuration details for device connections, such as connector types and connection IDs.

__init__()

Default constructor.

Initializes a new instance of the AdvancedConnectionConfig class.

fromXML(connectionNode)

Provide connection information from the XML node connectionNode.

Populates the connection configuration from the provided XML node.

Parameters:

Name Type Description Default
connectionNode XMLNode

XML 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 connection.

Retrieves the specific type of connection configuration.

Returns:

Type Description
int

The type of connection

getTypeProvided()

Get the provided connector type.

Retrieves the type of connector provided by this configuration.

Returns:

Type Description
int

The provided connector type

setTypeProvided(typeProvided)

Set the provided connector type.

Sets the type of connector provided by this configuration.

Parameters:

Name Type Description Default
typeProvided int

The provided connector type

required

getConnectionId()

Get the connection ID of the connector.

Retrieves the unique identifier of the connection.

Returns:

Type Description
int

The connection ID

setConnectionId(connectionId)

Set the connection ID of the connector.

Assigns a unique identifier to the connection.

Parameters:

Name Type Description Default
connectionId int

The connection ID

required