Skip to content

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


Inscoper::AdvancedConnectionConfig

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

#include <AdvancedConnectionConfig.h>

Inherits from Inscoper::ConnectionConfig

Public Functions

Name
AdvancedConnectionConfig()
Default constructor.
virtual void fromXML(Inscoper::XMLNode & connectionNode) override
Provide connection information from the XML node connectionNode.
virtual void toXML(Inscoper::XMLNode & xmlParent) override
Export connection information in an XML node attached to the parent XML node.
virtual Inscoper::EConnectionType getType() override
Return the type of connection.
Inscoper::EConnectorType getTypeProvided() const
Get the provided connector type.
void setTypeProvided(Inscoper::EConnectorType typeProvided)
Set the provided connector type.
unsigned char getConnectionId() const
Get the connection ID of the connector.
void setConnectionId(unsigned char connectionId)
Set the connection ID of the connector.

Additional inherited members

Public Functions inherited from Inscoper::ConnectionConfig

Name
ConnectionConfig()
Constructor.
ConnectionConfig(unsigned char tag)
Constructor.
virtual ~ConnectionConfig()
Default destructor.
unsigned short getTag() const
Get the tag of the current connection.
void setTag(unsigned short tag)
Set the tag of the current connection.

Detailed Description

class Inscoper::AdvancedConnectionConfig;

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

Note: 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.

Public Functions Documentation

function AdvancedConnectionConfig

AdvancedConnectionConfig()

Default constructor.

Initializes a new instance of the AdvancedConnectionConfig class.

function fromXML

virtual void fromXML(
    Inscoper::XMLNode & connectionNode
) override

Provide connection information from the XML node connectionNode.

Parameters:

  • connectionNode : XML node containing connection information

Exceptions:

Reimplements: Inscoper::ConnectionConfig::fromXML

Populates the connection configuration from the provided XML node.

function toXML

virtual void toXML(
    Inscoper::XMLNode & xmlParent
) override

Export connection information in an XML node attached to the parent XML node.

Parameters:

  • xmlParent : The parent XML node

Exceptions:

Reimplements: Inscoper::ConnectionConfig::toXML

Serializes the connection configuration to the specified parent XML node.

function getType

virtual Inscoper::EConnectionType getType() override

Return the type of connection.

Return: The type of connection

Reimplements: Inscoper::ConnectionConfig::getType

Retrieves the specific type of connection configuration.

function getTypeProvided

Inscoper::EConnectorType getTypeProvided() const

Get the provided connector type.

Return: The provided connector type

Retrieves the type of connector provided by this configuration.

function setTypeProvided

void setTypeProvided(
    Inscoper::EConnectorType typeProvided
)

Set the provided connector type.

Parameters:

  • typeProvided : The provided connector type

Sets the type of connector provided by this configuration.

function getConnectionId

unsigned char getConnectionId() const

Get the connection ID of the connector.

Return: The connection ID

Retrieves the unique identifier of the connection.

function setConnectionId

void setConnectionId(
    unsigned char connectionId
)

Set the connection ID of the connector.

Parameters:

  • connectionId : The connection ID

Assigns a unique identifier to the connection.


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