iv::comms::serial::SerialCommunicationsDriver Class Reference

#include <SerialCommunicationsDriver.hpp>

Inheritance diagram for iv::comms::serial::SerialCommunicationsDriver:

Collaboration diagram for iv::comms::serial::SerialCommunicationsDriver:

Public Member Functions
	SerialCommunicationsDriver ()
	SerialCommunicationsDriver (const SerialCommunicationsDriver &other)=delete
	SerialCommunicationsDriver (SerialCommunicationsDriver &&other)=delete
	~SerialCommunicationsDriver () override
SerialCommunicationsDriver &	operator= (const SerialCommunicationsDriver &other)=delete
SerialCommunicationsDriver &	operator= (SerialCommunicationsDriver &&other)=delete
void	configure (const iv::model::comms::NetworkData &commConfig) override
iv::comms::eResponse	init () override
iv::comms::eResponse	end () override
iv::comms::eResponse	reconnect () override
iv::comms::eResponse	start () override
iv::comms::eResponse	stop () override
void	emptyInputBuffer () const
iv::comms::eResponse	receive (std::vector< std::byte > &buffer, bool stopOnNewLine=true) const
iv::comms::eResponse	send (const std::vector< std::byte > &data) const
bool	isOnline () override

Protected Attributes
iv::eState	m_state {iv::eState::Uninitialized}
bool	m_isOnline {false}
iv::types::timestamp	m_lastTimeReconnected {0}

Private Attributes
iv::model::comms::serial::PortSettings	m_serialPortSettings
std::unique_ptr< SerialPort >	m_serialPort

Constructor & Destructor Documentation

SerialCommunicationsDriver() [1/3]

iv::comms::serial::SerialCommunicationsDriver::SerialCommunicationsDriver

(

)

SerialCommunicationsDriver() [2/3]

iv::comms::serial::SerialCommunicationsDriver::SerialCommunicationsDriver ( const SerialCommunicationsDriver & other )

delete

SerialCommunicationsDriver() [3/3]

iv::comms::serial::SerialCommunicationsDriver::SerialCommunicationsDriver ( SerialCommunicationsDriver && other )

delete

~SerialCommunicationsDriver()

iv::comms::serial::SerialCommunicationsDriver::~SerialCommunicationsDriver ( )

overridedefault

Member Function Documentation

configure()

void iv::comms::serial::SerialCommunicationsDriver::configure ( const iv::model::comms::NetworkData & commConfig )

overridevirtual

Implements iv::comms::ICommunicationDriver.

emptyInputBuffer()

void iv::comms::serial::SerialCommunicationsDriver::emptyInputBuffer

(

)

const

end()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::end ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

init()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::init ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

isOnline()

bool iv::comms::serial::SerialCommunicationsDriver::isOnline ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

operator=() [1/2]

SerialCommunicationsDriver & iv::comms::serial::SerialCommunicationsDriver::operator= ( const SerialCommunicationsDriver & other )

delete

operator=() [2/2]

SerialCommunicationsDriver & iv::comms::serial::SerialCommunicationsDriver::operator= ( SerialCommunicationsDriver && other )

delete

receive()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::receive	(	std::vector< std::byte > &	buffer,
		bool	stopOnNewLine = true ) const

reconnect()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::reconnect ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

send()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::send ( const std::vector< std::byte > & data ) const

nodiscard

start()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::start ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

stop()

iv::comms::eResponse iv::comms::serial::SerialCommunicationsDriver::stop ( )

overridevirtual

Implements iv::comms::ICommunicationDriver.

Member Data Documentation

m_isOnline

bool iv::comms::ICommunicationDriver::m_isOnline {false}

protectedinherited

m_lastTimeReconnected

iv::types::timestamp iv::comms::ICommunicationDriver::m_lastTimeReconnected {0}

protectedinherited

m_serialPort

std::unique_ptr<SerialPort> iv::comms::serial::SerialCommunicationsDriver::m_serialPort

private

m_serialPortSettings

iv::model::comms::serial::PortSettings iv::comms::serial::SerialCommunicationsDriver::m_serialPortSettings

private

m_state

iv::eState iv::comms::ICommunicationDriver::m_state {iv::eState::Uninitialized}

protectedinherited

---

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

• src/comms/serial/SerialCommunicationsDriver.hpp
• src/comms/serial/SerialCommunicationsDriver.cpp