Class CCANSimulation#

Inheritance Relationships#

Base Types#

Class Documentation#

class CCANSimulation : public sdv::CSdvObject, public sdv::can::IRegisterReceiver, public sdv::can::ISend, private sdv::can::IInformation#

Component to establish Socket CAN communication between VAPI and external application.

Public Functions

CCANSimulation()#

Constructor.

virtual ~CCANSimulation() override#

Destructor.

virtual bool OnInitialize() override#

Initialization event, called after object configuration was loaded. Overload of sdv::CSdvObject::OnInitialize.

Returns:

Returns ‘true’ when the initialization was successful, ‘false’ when not.

virtual void OnChangeToConfigMode() override#

Change to configuration mode event. After this a call to this function locked parameters can be changed again. Overload of sdv::CSdvObject::OnChangeToConfigMode.

virtual bool OnChangeToRunningMode() override#

Change to running mode event. Parameters were locked before the call to this event. Overload of sdv::CSdvObject::OnChangeToRunningMode.

Returns:

Returns ‘true’ when the configuration is valid and the running instances could be started. Otherwise returns ‘false’.

virtual void OnShutdown() override#

Shutdown the object. Overload of sdv::CSdvObject::OnShutdown.

virtual void RegisterReceiver(sdv::can::IReceive *pReceiver) override#

Register a CAN message receiver. Overload of sdv::can::IRegisterReceiver::RegisterReceiver.

Parameters:

pReceiver – [in] Pointer to the receiver interface.

virtual void UnregisterReceiver(sdv::can::IReceive *pReceiver) override#

Unregister a previously registered CAN message receiver. Overload of sdv::can::IRegisterReceiver::UnregisterReceiver.

Parameters:

pReceiver – [in] Pointer to the receiver interface.

virtual void Send(const sdv::can::SMessage &sMsg, uint32_t uiIfcIndex) override#

Send a CAN message. Overload of sdv::can::ISend::Send.

Parameters:

  • sMsg – [in] Message that is to be sent. The source node information is ignored. The target node determines over what interface the message will be sent.

  • uiIfcIndex – [in] Interface index to use for sending.

virtual sdv::sequence<sdv::u8string> GetInterfaces() const override#

Get a list of interface names. Overload of sdv::can::IInformation::GetInterfaces.

Returns:

Sequence containing the names of the interfaces.