ADTF Device Toolbox SDK
Loading...
Searching...
No Matches
adtf::devicetb::sdk::canfd::ignition::ICANFDSupport Class Referenceabstract

#include <canfd_support_srv_intf.h>

Inheritance diagram for adtf::devicetb::sdk::canfd::ignition::ICANFDSupport:
[legend]
Collaboration diagram for adtf::devicetb::sdk::canfd::ignition::ICANFDSupport:
[legend]

Public Member Functions

 ADTF_IID (ICANFDSupport, "canfd.ignition.canfd.sdk.devicetb.adtf.iid")
 
virtual tResult CreateCoder (adtf::ucom::iobject_ptr< ICANFDCoder > &pObj)=0
 
virtual tResult GetDatabase (tChannelID nChannel, adtf::ucom::ant::iobject_ptr< ICANFDDatabase > &pCANFDDatabase)=0
 
virtual tResult LoadDatabase (const char *strDatabaseFiles, const char *strClusterName, adtf::ucom::ant::iobject_ptr< ICANFDDatabase > &pCanfdDatabase)=0
 

Detailed Description

The ICANFDSupport interface

Member Function Documentation

◆ CreateCoder()

virtual tResult adtf::devicetb::sdk::canfd::ignition::ICANFDSupport::CreateCoder ( adtf::ucom::iobject_ptr< ICANFDCoder > & pObj)
pure virtual

Creates a new CANFD coder object.

Parameters
pObj[out] Pointer to object which implements ICANFDCoder interface
Returns
Returns a standard result code.

◆ GetDatabase()

virtual tResult adtf::devicetb::sdk::canfd::ignition::ICANFDSupport::GetDatabase ( tChannelID nChannel,
adtf::ucom::ant::iobject_ptr< ICANFDDatabase > & pCANFDDatabase )
pure virtual

Returns the CANFD Database for the channel

Parameters
[in]nChannelCANFD Channel number
[out]pCANDatabasePointer to CAN database
Returns
Returns a standard result code.

◆ LoadDatabase()

virtual tResult adtf::devicetb::sdk::canfd::ignition::ICANFDSupport::LoadDatabase ( const char * strDatabaseFiles,
const char * strClusterName,
adtf::ucom::ant::iobject_ptr< ICANFDDatabase > & pCanfdDatabase )
pure virtual

Loads all files from the file list (separated with semicolons or commas) and merge them together to one database.

Parameters
[in]strDatabaseFilesList of database files to load
[in]strClusterNameCluster name to be loaded (if there are multiple in one database)
[out]pCanfdDatabasePointer to object which implements ICANFDDatabase interface If more than one file is listed in strFileNames, the results will be merged.
Returns
Returns a standard result code.

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