imt::base::os::linux::SerialPort Class Reference

Provides functions to transmit serial port data. More...

#include <Imt.Base.OS.Linux/SerialPort.h>

Public Member Functions
	SerialPort (SerialPortConfig config) noexcept
	Constructor. More...
	~SerialPort ()
	Destructor. More...
size_t	read (uint8_t *const pData, size_t const countDataBytes) const
	Reads the given number of bytes from the serial port. More...
size_t	write (uint8_t const *const pData, size_t const countDataBytes) const
	Writes the given data to the serial port. More...
	SerialPort (SerialPort const &source)=delete
	SerialPort (SerialPort &&source) noexcept=delete
SerialPort &	operator= (SerialPort const &source)=delete
SerialPort &	operator= (SerialPort &&source) noexcept=delete

Detailed Description

Provides functions to transmit serial port data.

Constructor & Destructor Documentation

SerialPort() [1/3]

imt::base::os::linux::SerialPort::SerialPort ( SerialPortConfig  config )

noexcept

Constructor.

Parameters

config

The serial port configuration

~SerialPort()

imt::base::os::linux::SerialPort::~SerialPort

(

)

Destructor.

SerialPort() [2/3]

imt::base::os::linux::SerialPort::SerialPort ( SerialPort const &  source )

delete

SerialPort() [3/3]

imt::base::os::linux::SerialPort::SerialPort ( SerialPort &&  source )

deletenoexcept

Member Function Documentation

operator=() [1/2]

SerialPort& imt::base::os::linux::SerialPort::operator= ( SerialPort &&  source )

deletenoexcept

operator=() [2/2]

SerialPort& imt::base::os::linux::SerialPort::operator= ( SerialPort const &  source )

delete

read()

size_t imt::base::os::linux::SerialPort::read	(	uint8_t *const	pData,
		size_t const	countDataBytes
	)		const

Reads the given number of bytes from the serial port.

Parameters

pData	The buffer receiving the data
countDataBytes	The number of bytes to read

Returns

The number of bytes written into the buffer

write()

size_t imt::base::os::linux::SerialPort::write	(	uint8_t const *const	pData,
		size_t const	countDataBytes
	)		const

Writes the given data to the serial port.

Parameters

pData	The databuffer to send
countDataBytes	The number of data stored in the buffer

Returns

The number of bytes sent

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.OS.Linux/SerialPort.h