ADTF Device Toolbox SDK
Loading...
Searching...
No Matches
Public Member Functions | List of all members
adtf::devicetb::sdk::flexray::axle::IFlexRaySupport Class Referenceabstract

#include <flexray_support_srv_intf.h>

Inheritance diagram for adtf::devicetb::sdk::flexray::axle::IFlexRaySupport:
[legend]
Collaboration diagram for adtf::devicetb::sdk::flexray::axle::IFlexRaySupport:
[legend]

Public Member Functions

 ADTF_IID (IFlexRaySupport, IID_DEVTB_FLEXRAY_SUPPORT)
 
virtual tResult CreateCoder (const adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > &pDatabase, adtf::ucom::ant::iobject_ptr< IFlexRayCoder > &pObj)=0
 
virtual tResult GetDatabase (const adtf::devicetb::sdk::flexray::axle::tDeviceChannel nDeviceChannel, adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > &pObj)=0
 
virtual tResult LoadDatabase (const char *strDatabaseFiles, adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > &pDatabase)=0
 
virtual tResult SetDatabase (const tDeviceChannel nDeviceChannel, const char *strDatabaseFiles, const adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > &pObj)=0
 

Detailed Description

The IFlexRaySupport interface provides methods to query FIBEX databases

Member Function Documentation

◆ CreateCoder()

virtual tResult adtf::devicetb::sdk::flexray::axle::IFlexRaySupport::CreateCoder ( const adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > & pDatabase,
adtf::ucom::ant::iobject_ptr< IFlexRayCoder > & pObj )
pure virtual

Creates a new flexray coder object.

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

◆ GetDatabase()

virtual tResult adtf::devicetb::sdk::flexray::axle::IFlexRaySupport::GetDatabase ( const adtf::devicetb::sdk::flexray::axle::tDeviceChannel nDeviceChannel,
adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > & pObj )
pure virtual

Returns the default FIBEX database object.

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

◆ LoadDatabase()

virtual tResult adtf::devicetb::sdk::flexray::axle::IFlexRaySupport::LoadDatabase ( const char * strDatabaseFiles,
adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > & pDatabase )
pure virtual

Simply loads a FIBEX database from a file without side effects.

The loaded database is not set as property or registered to any stakeholder.

Parameters
[in]strDatabaseFilesDatabase file(s) to load
[out]pDatabaseReturns the database loaded from strFibexFile
Returns
Standard error code

◆ SetDatabase()

virtual tResult adtf::devicetb::sdk::flexray::axle::IFlexRaySupport::SetDatabase ( const tDeviceChannel nDeviceChannel,
const char * strDatabaseFiles,
const adtf::ucom::ant::iobject_ptr< IFlexRayDatabase > & pObj )
pure virtual

Sets the default FIBEX database object.

Parameters
nDeviceChannel[in] DeviceChannel for the requested flexray database
strDatabaseFile[in] Path to the requested Database. Important for traceability
pObj[in] Pointer to object which implements IFlexRayDatabase interface
Returns
Returns a standard result code.
The documentation for this class was generated from the following file: