Class CCANSilKit#

Nested Relationships#

Nested Types#

Inheritance Relationships#

Base Types#

Class Documentation#

class CCANSilKit : public sdv::CSdvObject, public sdv::IObjectControl, 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

virtual void Initialize(const sdv::u8string &ssObjectConfig) override#

Initialize the object. Overload of sdv::IObjectControl::Initialize.

Parameters:

ssObjectConfig – [in] Optional configuration string.

virtual sdv::EObjectStatus GetStatus() const override#

Get the current status of the object. Overload of sdv::IObjectControl::GetStatus.

Returns:

Return the current status of the object.

virtual void SetOperationMode(sdv::EOperationMode eMode) override#

Set the component operation mode. Overload of sdv::IObjectControl::SetOperationMode.

Parameters:

eMode – [in] The operation mode, the component should run in.

virtual void Shutdown() override#

Shutdown called before the object is destroyed. Overload of sdv::IObjectControl::Shutdown.

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 &sSDVCanMessage, uint32_t uiIfcIndex) override#

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

Parameters:

  • sSDVCanMessage – [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.