iv::comms::ICommunicationController Class Reference

#include <ICommunicationController.hpp>

Inheritance diagram for iv::comms::ICommunicationController:

Public Member Functions
	ICommunicationController ()=default
	ICommunicationController (const std::shared_ptr< iv::model::comms::NetworkData > &networkData, std::unique_ptr< iv::comms::ICommunicationDriver > driver, std::shared_ptr< bool > isEnabled)
	ICommunicationController (const ICommunicationController &other)=delete
	ICommunicationController (ICommunicationController &&other)=delete
virtual	~ICommunicationController ()
ICommunicationController &	operator= (const ICommunicationController &other)=delete
ICommunicationController &	operator= (ICommunicationController &&other)=delete
virtual void	addChannel (const std::shared_ptr< iv::channels::AbstractChannel > &channel)=0
virtual void	initialize ()=0
virtual bool	frame ()=0
void	pause () const
void	resume () const
iv::types::networkId	getNetworkId () const
std::shared_ptr< iv::model::comms::NetworkData >	getCommConfig () const
std::shared_ptr< iv::comms::ICommunicationDriver >	getDriver () const
bool	hasChannel (const iv::types::channelId &channelId) const
bool	isEnabled ()

Protected Attributes
iv::types::networkId	m_networkId
std::shared_ptr< bool >	m_isEnabled
std::shared_ptr< iv::model::comms::NetworkData >	m_commConfig
std::shared_ptr< iv::comms::ICommunicationProtocol >	m_protocol
std::shared_ptr< iv::comms::ICommunicationDriver >	m_driver
std::map< iv::types::channelId, std::shared_ptr< iv::channels::AbstractChannel > >	m_channels
std::weak_ptr< iv::channels::AbstractChannel >	m_errorChannel
std::weak_ptr< iv::channels::AbstractChannel >	m_heartbeatChannel
std::weak_ptr< iv::comms::ICommunicationController >	m_fallbackComm
std::weak_ptr< iv::diamar::AppFailuresLoggerManager >	m_appFailuresLoggerManager

Constructor & Destructor Documentation

ICommunicationController() [1/4]

iv::comms::ICommunicationController::ICommunicationController ( )

default

ICommunicationController() [2/4]

iv::comms::ICommunicationController::ICommunicationController	(	const std::shared_ptr< iv::model::comms::NetworkData > &	networkData,
		std::unique_ptr< iv::comms::ICommunicationDriver >	driver,
		std::shared_ptr< bool >	isEnabled )

ICommunicationController() [3/4]

iv::comms::ICommunicationController::ICommunicationController ( const ICommunicationController & other )

delete

ICommunicationController() [4/4]

iv::comms::ICommunicationController::ICommunicationController ( ICommunicationController && other )

delete

~ICommunicationController()

virtual iv::comms::ICommunicationController::~ICommunicationController ( )

inlinevirtual

Member Function Documentation

addChannel()

virtual void iv::comms::ICommunicationController::addChannel ( const std::shared_ptr< iv::channels::AbstractChannel > & channel )

pure virtual

Implemented in iv::comms::api::ApiCommunicationController, iv::comms::can::LomCommunicationController, iv::comms::canJ1939::CanJ1939CommunicationController, iv::comms::modbus::ModbusCommunicationController, iv::comms::nmea0183::Nmea0183CommunicationController, iv::comms::nmea2k::Nmea2kCommunicationController, iv::comms::redundancy::RedundancyCommunicationController, iv::comms::vdr::VdrCommunicationController, and iv::comms::watchcallNT::WatchcallNTCommunicationController.

frame()

virtual bool iv::comms::ICommunicationController::frame ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationController, iv::comms::can::LomCommunicationController, iv::comms::canJ1939::CanJ1939CommunicationController, iv::comms::modbus::ModbusCommunicationController, iv::comms::nmea0183::Nmea0183CommunicationController, iv::comms::nmea2k::Nmea2kCommunicationController, iv::comms::redundancy::RedundancyCommunicationController, iv::comms::vdr::VdrCommunicationController, and iv::comms::watchcallNT::WatchcallNTCommunicationController.

getCommConfig()

std::shared_ptr< iv::model::comms::NetworkData > iv::comms::ICommunicationController::getCommConfig ( ) const

inlinenodiscard

getDriver()

std::shared_ptr< iv::comms::ICommunicationDriver > iv::comms::ICommunicationController::getDriver ( ) const

inlinenodiscard

getNetworkId()

iv::types::networkId iv::comms::ICommunicationController::getNetworkId ( ) const

inlinenodiscard

hasChannel()

bool iv::comms::ICommunicationController::hasChannel ( const iv::types::channelId & channelId ) const

inlinenodiscard

initialize()

virtual void iv::comms::ICommunicationController::initialize ( )

pure virtual

Implemented in iv::comms::api::ApiCommunicationController, iv::comms::can::LomCommunicationController, iv::comms::canJ1939::CanJ1939CommunicationController, iv::comms::modbus::ModbusCommunicationController, iv::comms::nmea0183::Nmea0183CommunicationController, iv::comms::nmea2k::Nmea2kCommunicationController, iv::comms::redundancy::RedundancyCommunicationController, iv::comms::vdr::VdrCommunicationController, and iv::comms::watchcallNT::WatchcallNTCommunicationController.

isEnabled()

bool iv::comms::ICommunicationController::isEnabled ( )

inlinenodiscard

operator=() [1/2]

ICommunicationController & iv::comms::ICommunicationController::operator= ( const ICommunicationController & other )

delete

operator=() [2/2]

ICommunicationController & iv::comms::ICommunicationController::operator= ( ICommunicationController && other )

delete

pause()

void iv::comms::ICommunicationController::pause ( ) const

inline

resume()

void iv::comms::ICommunicationController::resume ( ) const

inline

Member Data Documentation

m_appFailuresLoggerManager

std::weak_ptr<iv::diamar::AppFailuresLoggerManager> iv::comms::ICommunicationController::m_appFailuresLoggerManager

protected

m_channels

std::map<iv::types::channelId, std::shared_ptr<iv::channels::AbstractChannel> > iv::comms::ICommunicationController::m_channels

protected

m_commConfig

std::shared_ptr<iv::model::comms::NetworkData> iv::comms::ICommunicationController::m_commConfig

protected

m_driver

std::shared_ptr<iv::comms::ICommunicationDriver> iv::comms::ICommunicationController::m_driver

protected

m_errorChannel

std::weak_ptr<iv::channels::AbstractChannel> iv::comms::ICommunicationController::m_errorChannel

protected

m_fallbackComm

std::weak_ptr<iv::comms::ICommunicationController> iv::comms::ICommunicationController::m_fallbackComm

protected

m_heartbeatChannel

std::weak_ptr<iv::channels::AbstractChannel> iv::comms::ICommunicationController::m_heartbeatChannel

protected

m_isEnabled

std::shared_ptr<bool> iv::comms::ICommunicationController::m_isEnabled

protected

m_networkId

iv::types::networkId iv::comms::ICommunicationController::m_networkId

protected

m_protocol

std::shared_ptr<iv::comms::ICommunicationProtocol> iv::comms::ICommunicationController::m_protocol

protected

---

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

• src/comms/ICommunicationController.hpp
• src/comms/ICommunicationController.cpp