The config for the CAN Connector. More...

#include <CANConnectorConfig.h>

Inheritance diagram for sim_interface::dut_connector::can::CANConnectorConfig:

Public Member Functions
	CANConnectorConfig (std::string interfaceName, std::string codecName, std::set< std::string > operations, std::map< canid_t, CANConnectorReceiveOperation > frameToOperation={}, std::map< std::string, CANConnectorSendOperation > operationToFrame={}, std::map< std::string, int > periodicOperations={}, bool periodicTimerEnabled=false)

Public Member Functions inherited from sim_interface::dut_connector::ConnectorConfig
	ConnectorConfig (std::set< std::string > operations, std::map< std::string, int > periodicOperations={}, bool periodicTimerEnabled=false)

virtual	~ConnectorConfig ()=default

Public Attributes
std::string	interfaceName

std::string	codecName

std::map< canid_t, CANConnectorReceiveOperation >	frameToOperation

std::map< std::string, CANConnectorSendOperation >	operationToFrame

Public Attributes inherited from sim_interface::dut_connector::ConnectorConfig
std::set< std::string >	operations {}

std::map< std::string, int >	periodicOperations {}

bool	periodicTimerEnabled = false

Detailed Description

The config for the CAN Connector.

Constructor & Destructor Documentation

◆ CANConnectorConfig()

sim_interface::dut_connector::can::CANConnectorConfig::CANConnectorConfig	(	std::string	interfaceName,
		std::string	codecName,
		std::set< std::string >	operations,
		std::map< canid_t, CANConnectorReceiveOperation >	frameToOperation = `{}`,
		std::map< std::string, CANConnectorSendOperation >	operationToFrame = `{}`,
		std::map< std::string, int >	periodicOperations = `{}`,
		bool	periodicTimerEnabled = `false`
	)

explicit

Constructor for the CAN Connector configuration.

Parameters

interfaceName	- The name of the interface that should be used by the connector.
operations	- The operations supported by the CAN Connector.
codecName	- The name of the codec that should be used by the connector.
frameToOperation	- The configurations for the receive operations.
operationToFrame	- The configurations for the send operations.
periodicOperations	- The periodic operations supported by the connector through the interface.
periodicTimerEnabled	- Flag that enables the periodic sending through the interface. Since the BCM socket supports cyclic operations this should always be false

Member Data Documentation

◆ codecName

std::string sim_interface::dut_connector::can::CANConnectorConfig::codecName

The name of the codec that should be used.

◆ frameToOperation

std::map<canid_t, CANConnectorReceiveOperation> sim_interface::dut_connector::can::CANConnectorConfig::frameToOperation

This map is used to set up the RX filters of the BCM socket based on the receive operation data that was defined in the XML configuration file.

◆ interfaceName

std::string sim_interface::dut_connector::can::CANConnectorConfig::interfaceName

The name of the interface that should be used.

◆ operationToFrame

std::map<std::string, CANConnectorSendOperation> sim_interface::dut_connector::can::CANConnectorConfig::operationToFrame

This map is used to get the send operation data (like the CAN ID, interval information etc.) that was defined in the XML configuration file. The Key that is used is returned by the Codec and must therefore match with a sendOperation entry that is defined in the XML configuration file.

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

Sim_To_DuT_Interface/DuT_Connectors/CANConnector/CANConnectorConfig.h
Sim_To_DuT_Interface/DuT_Connectors/CANConnector/CANConnectorConfig.cpp

Public Member Functions

Public Attributes