SerialConfiguration Class Reference

#include <SerialLink.h>

Inheritance diagram for SerialConfiguration:

Collaboration diagram for SerialConfiguration:

Signals
void	baudChanged ()
void	dataBitsChanged ()
void	flowControlChanged ()
void	stopBitsChanged ()
void	parityChanged ()
void	portNameChanged ()
void	portDisplayNameChanged ()
void	usbDirectChanged ()
void	dtrForceLowChanged ()
Signals inherited from LinkConfiguration
void	nameChanged (const QString &name)
void	linkChanged ()
void	dynamicChanged ()
void	autoConnectChanged ()
void	highLatencyChanged ()

Public Member Functions
	SerialConfiguration (const QString &name, QObject *parent=nullptr)
	SerialConfiguration (const SerialConfiguration *copy, QObject *parent=nullptr)
virtual	~SerialConfiguration ()
LinkType	type () const override
void	copyFrom (const LinkConfiguration *source) override
void	loadSettings (QSettings &settings, const QString &root) override
void	saveSettings (QSettings &settings, const QString &root) const override
QString	settingsURL () const override
	Settings URL, Pure virtual method providing the URL for the (QML) settings dialog.
QString	settingsTitle () const override
	Settings Title, Pure virtual method providing the Title for the (QML) settings dialog.
qint32	baud () const
void	setBaud (qint32 baud)
QSerialPort::DataBits	dataBits () const
void	setDataBits (QSerialPort::DataBits databits)
QSerialPort::FlowControl	flowControl () const
void	setFlowControl (QSerialPort::FlowControl flowControl)
QSerialPort::StopBits	stopBits () const
void	setStopBits (QSerialPort::StopBits stopBits)
QSerialPort::Parity	parity () const
void	setParity (QSerialPort::Parity parity)
QString	portName () const
void	setPortName (const QString &name)
QString	portDisplayName () const
void	setPortDisplayName (const QString &portDisplayName)
bool	usbDirect () const
void	setUsbDirect (bool usbDirect)
bool	dtrForceLow () const
void	setdtrForceLow (bool dtrForceLow)
Public Member Functions inherited from LinkConfiguration
	LinkConfiguration (const QString &name, QObject *parent=nullptr)
	LinkConfiguration (const LinkConfiguration *copy, QObject *parent=nullptr)
virtual	~LinkConfiguration ()
QString	name () const
void	setName (const QString &name)
LinkInterface *	link () const
void	setLink (const std::shared_ptr< LinkInterface > link)
bool	isDynamic () const
void	setDynamic (bool dynamic=true)
	Set if this is this a dynamic configuration. (decided at runtime)
bool	isForwarding () const
void	setForwarding (bool forwarding=true)
	Set if this is this a forwarding link configuration. (decided at runtime)
bool	isAutoConnect () const
virtual void	setAutoConnect (bool autoc=true)
	Set if this is this an Auto Connect configuration.
bool	isHighLatency () const
void	setHighLatency (bool hl=false)
	Set if this is this an High Latency configuration.

Static Public Member Functions
static QStringList	supportedBaudRates ()
static QString	cleanPortDisplayName (const QString &name)
Static Public Member Functions inherited from LinkConfiguration
static LinkConfiguration *	createSettings (int type, const QString &name)
static LinkConfiguration *	duplicateSettings (const LinkConfiguration *source)
static QString	settingsRoot ()

Additional Inherited Members
Public Types inherited from LinkConfiguration
enum	LinkType {   TypeSerial , TypeUdp , TypeTcp , TypeBluetooth ,   TypeLogReplay , TypeLast }
Protected Attributes inherited from LinkConfiguration
std::weak_ptr< LinkInterface >	_link
	Link currently using this configuration (if any)

Detailed Description

Definition at line 20 of file SerialLink.h.

Constructor & Destructor Documentation

SerialConfiguration() [1/2]

SerialConfiguration::SerialConfiguration ( const QString &  name, QObject *  parent = nullptr  )

explicit

Definition at line 17 of file SerialLink.cc.

SerialConfiguration() [2/2]

SerialConfiguration::SerialConfiguration ( const SerialConfiguration *  copy, QObject *  parent = nullptr  )

explicit

Definition at line 23 of file SerialLink.cc.

References copyFrom().

~SerialConfiguration()

SerialConfiguration::~SerialConfiguration ( )

virtual

Definition at line 31 of file SerialLink.cc.

Member Function Documentation

baud()

qint32 SerialConfiguration::baud ( ) const

inline

Definition at line 45 of file SerialLink.h.

Referenced by copyFrom(), and setBaud().

baudChanged

void SerialConfiguration::baudChanged ( )

signal

Referenced by setBaud().

cleanPortDisplayName()

QString SerialConfiguration::cleanPortDisplayName ( const QString &  name )

static

Definition at line 165 of file SerialLink.cc.

References QSerialPortInfo::availablePorts(), and LinkConfiguration::name().

Referenced by setPortName().

copyFrom()

void SerialConfiguration::copyFrom ( const LinkConfiguration *  source )

overridevirtual

Copy instance data, When manipulating data, you create a copy of the configuration using the copy constructor, edit it and then transfer its content to the original using this method.

Parameters

[in]

source

The source instance (the edited copy)

Reimplemented from LinkConfiguration.

Definition at line 52 of file SerialLink.cc.

References baud(), LinkConfiguration::copyFrom(), dataBits(), dtrForceLow(), flowControl(), parity(), portDisplayName(), portName(), setBaud(), setDataBits(), setdtrForceLow(), setFlowControl(), setParity(), setPortDisplayName(), setPortName(), setStopBits(), setUsbDirect(), stopBits(), and usbDirect().

Referenced by SerialConfiguration().

dataBits()

QSerialPort::DataBits SerialConfiguration::dataBits ( ) const

inline

Definition at line 48 of file SerialLink.h.

Referenced by copyFrom().

dataBitsChanged

void SerialConfiguration::dataBitsChanged ( )

signal

Referenced by setDataBits().

dtrForceLow()

bool SerialConfiguration::dtrForceLow ( ) const

inline

Definition at line 69 of file SerialLink.h.

Referenced by copyFrom(), and setdtrForceLow().

dtrForceLowChanged

void SerialConfiguration::dtrForceLowChanged ( )

signal

Referenced by setdtrForceLow().

flowControl()

QSerialPort::FlowControl SerialConfiguration::flowControl ( ) const

inline

Definition at line 51 of file SerialLink.h.

Referenced by copyFrom(), and setFlowControl().

flowControlChanged

void SerialConfiguration::flowControlChanged ( )

signal

Referenced by setFlowControl().

loadSettings()

void SerialConfiguration::loadSettings ( QSettings &  settings, const QString &  root  )

overridevirtual

Load settings, Pure virtual method telling the instance to load its configuration.

Parameters

[in]	settings	The QSettings instance to use
[in]	root	The root path of the setting.

Implements LinkConfiguration.

Definition at line 69 of file SerialLink.cc.

References setBaud(), setDataBits(), setdtrForceLow(), setFlowControl(), setParity(), setPortDisplayName(), setPortName(), and setStopBits().

parity()

QSerialPort::Parity SerialConfiguration::parity ( ) const

inline

Definition at line 57 of file SerialLink.h.

Referenced by copyFrom(), and setParity().

parityChanged

void SerialConfiguration::parityChanged ( )

signal

Referenced by setParity().

portDisplayName()

QString SerialConfiguration::portDisplayName ( ) const

inline

Definition at line 63 of file SerialLink.h.

Referenced by copyFrom(), setPortDisplayName(), and setPortName().

portDisplayNameChanged

void SerialConfiguration::portDisplayNameChanged ( )

signal

Referenced by setPortDisplayName().

portName()

QString SerialConfiguration::portName ( ) const

inline

Definition at line 60 of file SerialLink.h.

Referenced by SerialWorker::connectToPort(), copyFrom(), and setPortName().

portNameChanged

void SerialConfiguration::portNameChanged ( )

signal

Referenced by setPortName().

saveSettings()

void SerialConfiguration::saveSettings ( QSettings &  settings, const QString &  root  ) const

overridevirtual

Save settings, Pure virtual method telling the instance to save its configuration.

Parameters

[in]	settings	The QSettings instance to use
[in]	root	The root path of the setting.

Implements LinkConfiguration.

Definition at line 85 of file SerialLink.cc.

setBaud()

void SerialConfiguration::setBaud ( qint32  baud )

inline

Definition at line 46 of file SerialLink.h.

References baud(), and baudChanged().

Referenced by copyFrom(), and loadSettings().

setDataBits()

void SerialConfiguration::setDataBits ( QSerialPort::DataBits  databits )

inline

Definition at line 49 of file SerialLink.h.

References dataBitsChanged().

Referenced by copyFrom(), and loadSettings().

setdtrForceLow()

void SerialConfiguration::setdtrForceLow ( bool  dtrForceLow )

inline

Definition at line 70 of file SerialLink.h.

References dtrForceLow(), and dtrForceLowChanged().

Referenced by copyFrom(), and loadSettings().

setFlowControl()

void SerialConfiguration::setFlowControl ( QSerialPort::FlowControl  flowControl )

inline

Definition at line 52 of file SerialLink.h.

References flowControl(), and flowControlChanged().

Referenced by copyFrom(), and loadSettings().

setParity()

void SerialConfiguration::setParity ( QSerialPort::Parity  parity )

inline

Definition at line 58 of file SerialLink.h.

References parity(), and parityChanged().

Referenced by copyFrom(), and loadSettings().

setPortDisplayName()

void SerialConfiguration::setPortDisplayName ( const QString &  portDisplayName )

inline

Definition at line 64 of file SerialLink.h.

References portDisplayName(), and portDisplayNameChanged().

Referenced by copyFrom(), loadSettings(), and setPortName().

setPortName()

void SerialConfiguration::setPortName

(

const QString &

name

)

Definition at line 36 of file SerialLink.cc.

References cleanPortDisplayName(), LinkConfiguration::name(), portDisplayName(), portName(), portNameChanged(), and setPortDisplayName().

Referenced by copyFrom(), and loadSettings().

setStopBits()

void SerialConfiguration::setStopBits ( QSerialPort::StopBits  stopBits )

inline

Definition at line 55 of file SerialLink.h.

References stopBits(), and stopBitsChanged().

Referenced by copyFrom(), and loadSettings().

settingsTitle()

QString SerialConfiguration::settingsTitle ( ) const

inlineoverridevirtual

Settings Title, Pure virtual method providing the Title for the (QML) settings dialog.

Implements LinkConfiguration.

Definition at line 43 of file SerialLink.h.

settingsURL()

QString SerialConfiguration::settingsURL ( ) const

inlineoverridevirtual

Settings URL, Pure virtual method providing the URL for the (QML) settings dialog.

Implements LinkConfiguration.

Definition at line 42 of file SerialLink.h.

setUsbDirect()

void SerialConfiguration::setUsbDirect ( bool  usbDirect )

inline

Definition at line 67 of file SerialLink.h.

References usbDirect(), and usbDirectChanged().

Referenced by copyFrom().

stopBits()

QSerialPort::StopBits SerialConfiguration::stopBits ( ) const

inline

Definition at line 54 of file SerialLink.h.

Referenced by copyFrom(), and setStopBits().

stopBitsChanged

void SerialConfiguration::stopBitsChanged ( )

signal

Referenced by setStopBits().

supportedBaudRates()

QStringList SerialConfiguration::supportedBaudRates ( )

static

Definition at line 101 of file SerialLink.cc.

References QSerialPortInfo::standardBaudRates().

Referenced by LinkManager::serialBaudRates().

type()

LinkType SerialConfiguration::type ( ) const

inlineoverridevirtual

Connection type, pure virtual method returning one of the -TypeXxx types above.

Returns

The type of links these settings belong to.

Implements LinkConfiguration.

Definition at line 38 of file SerialLink.h.

References LinkConfiguration::TypeSerial.

usbDirect()

bool SerialConfiguration::usbDirect ( ) const

inline

Definition at line 66 of file SerialLink.h.

Referenced by copyFrom(), LinkManager::isLinkUSBDirect(), SerialLink::isSecureConnection(), and setUsbDirect().

usbDirectChanged

void SerialConfiguration::usbDirectChanged ( )

signal

Referenced by setUsbDirect().

---

The documentation for this class was generated from the following files:

• src/Comms/SerialLink.h
• src/Comms/SerialLink.cc