ADTF_DEVICE_TOOLBOX  3.12.0 (ADTF 3.18.3)
IBusDatabaseLoaderabstract

Interface for implementing bus database readers. More...

Inheritance diagram for IBusDatabaseLoader:
[legend]

Public Member Functions

 ADTF_IID (IBusDatabaseLoader, "bus_database_loader.cylinder.sdk.devicetb.adtf.iid")
 
virtual tResult Accept (const adtf::base::ant::IProperties &oProperties) const =0
 Checks if the parser supports the requested bus database. More...
 
virtual tResult Load (const adtf::base::ant::IProperties &oProperties, adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &pDatabase)=0
 Reads bus database files into an instance of a database object. More...
 
virtual const char * GetName () const =0
 Returns the name of the implementing parser instance. More...
 

Detailed Description

Interface for implementing bus database readers.

Inherit this interface in your class in order to implement your own parser for bus communication specifications. Such a parser can be registered in the CAN/LIN/FlexRay Support Services as providers for bus communication descriptions if you have special needs or different file formats other than DBC or FIBEX.

Definition at line 196 of file bus_database_intf.h.

Member Function Documentation

◆ Accept()

virtual tResult Accept ( const adtf::base::ant::IProperties &  oProperties) const
pure virtual

Checks if the parser supports the requested bus database.

Implement this to check if the files passed as parameter can or should be handled by this implementation of IBusDatabaseLoader.

Parameters
[in]oPropertiesparser relevant properties.
Returns
standard error code

◆ GetName()

virtual const char* GetName ( ) const
pure virtual

Returns the name of the implementing parser instance.

Implement this method in order to be able to identify which implementation for reading a bus database has been used (will be mentioned in console log window).

Returns
name of the implementing instance

◆ Load()

virtual tResult Load ( const adtf::base::ant::IProperties &  oProperties,
adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &  pDatabase 
)
pure virtual

Reads bus database files into an instance of a database object.

Implement this method to create an instance of a CAN/FlexRay database and load the contents of the file passed as parameter into that instance.

Parameters
[in]oPropertiesparser relevant properties.
[out]pDatabasepointer to the new database object instance.
Returns
standard error code