The SerialPortParams2Interface is a cross-platform interface to common serial port parameters. More...
#include <serialportparams2interface.h>
Public Member Functions | |
| virtual void | portName (BasicStringInterface &str) const =0 |
| virtual void | setPortName (const char *szPort)=0 |
| virtual unsigned int | baudRate () const =0 |
| virtual void | setBaudRate (unsigned int)=0 |
| virtual bool | isBaudRateFixed () const =0 |
| virtual SerXInterface::Parity | parity () const =0 |
| virtual void | setParity (const SerXInterface::Parity &parity)=0 |
| virtual bool | isParityFixed () const =0 |
| virtual int | dataBits () const |
| virtual void | setDataBits (const int &nValue) |
| virtual bool | isDataBitsFixed () |
| virtual int | stopBits () const |
| virtual void | setStopBits (const int &nValue) |
| virtual bool | isStopBitsFixed () |
| virtual int | flowControl () const |
| virtual void | setFlowControl (const int &nValue) |
| virtual bool | isFlowControlFixed () |
Detailed Description
The SerialPortParams2Interface is a cross-platform interface to common serial port parameters.
For serial devices, implementing this interface causes TheSkyX to display a general serial port settings user interface for setting serial port parameters. This does not encompass all serial port parameters for all operating systems, but does cover the most common serial port settings applied to astronomical hardware.
New to TheSkyX Version 10.1.10 (build 4443 and later) a "More Settings" button appears on TheSkyX's general "Serial Port Settings" dialog if the underlying X2 driver also implements the ModalSettingsDialogInterface. This allows X2 drivers to leverage TheSkyX's general "Serial Port Settings" dialog while also having a custom user interface that is displayed when the "More Settings" button is pressed.
In prior TheSkyX builds, the ModalSettingsDialogInterface and SerialPortParams2Interface where mutually exclusive but that is no longer the case and X2 implementor don't need to duplicate the serial port settings in their custom user interface.
Member Function Documentation
◆ baudRate()
|
pure virtual |
Return the buad rate.
Implemented in X2Rotator.
◆ dataBits()
|
inlinevirtual |
Return the number of data bits.
◆ flowControl()
|
inlinevirtual |
Return the flow control. Zero means no flow control.
◆ isBaudRateFixed()
|
pure virtual |
Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.
Implemented in X2Rotator.
◆ isDataBitsFixed()
|
inlinevirtual |
Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.
◆ isFlowControlFixed()
|
inlinevirtual |
Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.
◆ isParityFixed()
|
pure virtual |
Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.
Implemented in X2Rotator.
◆ isStopBitsFixed()
|
inlinevirtual |
Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.
◆ parity()
|
pure virtual |
Return the parity.
Implemented in X2Rotator.
◆ portName()
|
pure virtual |
Return serial port name as a string.
Implemented in X2Rotator.
◆ setBaudRate()
|
pure virtual |
Set the baud rate.
Implemented in X2Rotator.
◆ setDataBits()
|
inlinevirtual |
Set the number of data bits.
◆ setFlowControl()
|
inlinevirtual |
Set the flow control.
◆ setParity()
|
pure virtual |
Set the parity.
Implemented in X2Rotator.
◆ setPortName()
|
pure virtual |
Set the serial port name as a string.
Implemented in X2Rotator.
◆ setStopBits()
|
inlinevirtual |
Set the number of stop bits.
◆ stopBits()
|
inlinevirtual |
Return the number of stop bits.
The documentation for this class was generated from the following file:
- licensedinterfaces/serialportparams2interface.h