ADTF Device Toolbox SDK
Loading...
Searching...
No Matches
adtf::devicetb::sdk::can::axle::ICANSupport Class Referenceabstract

#include <can_support_srv_intf.h>

Inheritance diagram for adtf::devicetb::sdk::can::axle::ICANSupport:
[legend]
Collaboration diagram for adtf::devicetb::sdk::can::axle::ICANSupport:
[legend]

Public Member Functions

 ADTF_IID (ICANSupport, "can.axle.can.sdk.devicetb.adtf.iid")
 
virtual tResult CreateCoder (adtf::ucom::ant::iobject_ptr< ICANCoder > &pObj)=0
 
virtual tResult GetDatabase (tChannelID nChannel, adtf::ucom::ant::iobject_ptr< ICANDatabase > &pCANDatabase)=0
 
virtual tResult LoadDatabase (const char *strDatabaseFiles, adtf::ucom::ant::iobject_ptr< ICANDatabase > &pCanDatabase)=0
 

Detailed Description

The ICANSupport interface

Member Function Documentation

◆ CreateCoder()

virtual tResult adtf::devicetb::sdk::can::axle::ICANSupport::CreateCoder ( adtf::ucom::ant::iobject_ptr< ICANCoder > & pObj)
pure virtual

Creates a new CAN coder object.

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

◆ GetDatabase()

virtual tResult adtf::devicetb::sdk::can::axle::ICANSupport::GetDatabase ( tChannelID nChannel,
adtf::ucom::ant::iobject_ptr< ICANDatabase > & pCANDatabase )
pure virtual

Returns the CAN Database for the channel

Parameters
[in]nChannelCAN Channel number
[out]pCANDatabasePointer to CAN database
Return values
ERR_NOERRORNo Error.
ERR_NOT_FOUNDFor the given channel no CAN database is defined

◆ LoadDatabase()

virtual tResult adtf::devicetb::sdk::can::axle::ICANSupport::LoadDatabase ( const char * strDatabaseFiles,
adtf::ucom::ant::iobject_ptr< ICANDatabase > & pCanDatabase )
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 DBC files to load
[out]pCanDatabasePointer to object which implements ICANDatabase interface If more than one file is listed in strFileNames, the results will be merged.
Return values
ERR_NOERRORNo Error.
ERR_NOT_FOUNDone or more files cannot be loaded

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