iv::comms::ICommunicationDriver Class Reference

#include <ICommunicationDriver.hpp>

Inheritance diagram for iv::comms::ICommunicationDriver:

Public Member Functions
virtual	~ICommunicationDriver ()=default
virtual void	configure (const iv::model::comms::NetworkData &commConfig)=0
virtual iv::comms::eResponse	init ()=0
virtual iv::comms::eResponse	end ()=0
virtual iv::comms::eResponse	reconnect ()=0
virtual iv::comms::eResponse	start ()=0
virtual iv::comms::eResponse	stop ()=0
virtual bool	isOnline ()=0

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

Constructor & Destructor Documentation

~ICommunicationDriver()

virtual iv::comms::ICommunicationDriver::~ICommunicationDriver ( )

virtualdefault

Member Function Documentation

configure()

virtual void iv::comms::ICommunicationDriver::configure ( const iv::model::comms::NetworkData & commConfig )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

end()

virtual iv::comms::eResponse iv::comms::ICommunicationDriver::end ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

init()

virtual iv::comms::eResponse iv::comms::ICommunicationDriver::init ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

isOnline()

virtual bool iv::comms::ICommunicationDriver::isOnline ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

reconnect()

virtual iv::comms::eResponse iv::comms::ICommunicationDriver::reconnect ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

start()

virtual iv::comms::eResponse iv::comms::ICommunicationDriver::start ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

stop()

virtual iv::comms::eResponse iv::comms::ICommunicationDriver::stop ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationDriver, iv::comms::ip::IPCommunicationDriver, iv::comms::ixxat::IxxatCommunicationsDriver, iv::comms::serial::SerialCommunicationsDriver, and iv::comms::socketcan::SocketCanCommunicationsDriver.

Member Data Documentation

m_isOnline

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

protected

m_lastTimeReconnected

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

protected

m_state

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

protected

---

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

• src/comms/ICommunicationDriver.hpp