ADTF_DEVICE_TOOLBOX  3.12.1 (ADTF 3.18.3)
ICANFDDatabaseabstract

The ICANFDDatabase interface. More...

Inheritance diagram for ICANFDDatabase:
[legend]

Public Member Functions

 ADTF_IID (ICANFDDatabase, "canfd_database.ignition.canfd.sdk.devicetb.adtf.iid")
 
virtual tResult GetClusterName (const char **pstrClusterName) const =0
 Returns the cluster name. More...
 
virtual tResult GetFrameInfo (tFrameID nFrameId, const tFrameInfo **pFrameInfo) const =0
 Returns the information structure for the specified frame by its internal frame id. More...
 
virtual tResult GetFrameInfo (const char *pstrFrame, const tFrameInfo **pFrameInfo) const =0
 Returns the information structure for the specified frame by the frame name. More...
 
virtual tResult ResolveFrameInfo (tMessageID nMessageId, const tFrameInfo **pFrameInfo) const =0
 Returns the information structure for the specified frame by its database message id. More...
 
virtual tResult GetFrameSignalInfos (tFrameID nFrameId, const ucom::nitro::ifunction< void(const tSignalInfo *pSignalInfo)> &fnCallback) const =0
 Returns the all frame specific signal information structure by the frame id. More...
 
virtual tResult GetFramePduInfos (tFrameID nFrameId, const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo)> &fnCallback) const =0
 Returns the all frame specific signal information structure by the frame id. More...
 
virtual tResult GetClusterFrames (const ucom::nitro::ifunction< void(const tFrameInfo *pFrameInfo) > &fnCallback) const =0
 Returns all frame infos from the current cluster. More...
 
virtual tResult GetPduInfo (tPDUID nPduId, const tPduInfo **pPduInfo) const =0
 Returns the information structure for the specified pdu by its internal pdu id. More...
 
virtual tResult GetParentPdu (tPDUID nChildPduId, const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &fnCallback) const =0
 Returns all parent PDU infos which contain the child PDU id. More...
 
virtual tResult GetClusterPdus (const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &fnCallback) const =0
 Returns all PDU infos from the current cluster. More...
 
virtual tResult GetSignalInfo (tSignalID nSignalId, const tSignalInfo **pSignalInfo) const =0
 Returns the information structure about a signal by its internal id. More...
 
virtual tResult GetSignalInfo (const char *pstrSignal, const tSignalInfo **pSignalInfo) const =0
 Returns the information structure about a signal by its signal name. More...
 
virtual tResult GetPdusBySignal (tSignalID nSignalId, const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &fnCallback) const =0
 Returns all PDU infos which contain the signal id. More...
 
virtual tResult GetClusterSignals (const ucom::nitro::ifunction< void(const tSignalInfo *pSignalInfo) > &fnCallback) const =0
 Returns all signal infos from the current cluster. More...
 
virtual tResult GetClusterEcus (const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &fnCallback) const =0
 Returns all ECU infos from the current cluster. More...
 
virtual tResult GetReceiverEcusByFrame (tFrameID nFrameId, const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &fnCallback) const =0
 Returns all ECU infos which are received by the specified internal frame id. More...
 
virtual tResult GetSenderEcusByFrame (tFrameID nFrameId, const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &fnCallback) const =0
 Returns all ECU infos which are sent by the specified internal frame id. More...
 

Detailed Description

The ICANFDDatabase interface.

Definition at line 207 of file canfd_database_intf.h.

Member Function Documentation

◆ GetClusterEcus()

virtual tResult GetClusterEcus ( const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &  fnCallback) const
pure virtual

Returns all ECU infos from the current cluster.

Parameters
fnCallback[out] Callback function to get all cluster ECU infos
Returns
Standard Result Code

◆ GetClusterFrames()

virtual tResult GetClusterFrames ( const ucom::nitro::ifunction< void(const tFrameInfo *pFrameInfo) > &  fnCallback) const
pure virtual

Returns all frame infos from the current cluster.

Parameters
fnCallback[out] Callback function to get all cluster frame infos
Returns
Standard Result Code

◆ GetClusterName()

virtual tResult GetClusterName ( const char **  pstrClusterName) const
pure virtual

Returns the cluster name.

Parameters
pstrClusterName[out] Cluster name
Returns
Standard Result Code

◆ GetClusterPdus()

virtual tResult GetClusterPdus ( const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &  fnCallback) const
pure virtual

Returns all PDU infos from the current cluster.

Parameters
fnCallback[out] Callback function to get all cluster PDU infos
Returns
Standard Result Code

◆ GetClusterSignals()

virtual tResult GetClusterSignals ( const ucom::nitro::ifunction< void(const tSignalInfo *pSignalInfo) > &  fnCallback) const
pure virtual

Returns all signal infos from the current cluster.

Parameters
fnCallback[out] Callback function to get all cluster signal infos
Returns
Standard Result Code

◆ GetFrameInfo() [1/2]

virtual tResult GetFrameInfo ( const char *  pstrFrame,
const tFrameInfo **  pFrameInfo 
) const
pure virtual

Returns the information structure for the specified frame by the frame name.

Parameters
pstrFrame[in] Frame name
pFrameInfo[out] Frame information structure
Returns
Standard Result Code

◆ GetFrameInfo() [2/2]

virtual tResult GetFrameInfo ( tFrameID  nFrameId,
const tFrameInfo **  pFrameInfo 
) const
pure virtual

Returns the information structure for the specified frame by its internal frame id.

Parameters
nFrameId[in] Frame Id
pFrameInfo[out] Frame information structure
Returns
Standard Result Code

◆ GetFramePduInfos()

virtual tResult GetFramePduInfos ( tFrameID  nFrameId,
const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo)> &  fnCallback 
) const
pure virtual

Returns the all frame specific signal information structure by the frame id.

Parameters
nFrameId[in] Frame Id
pFrameInfo[out] Frame information structure
Returns
Standard Result Code

◆ GetFrameSignalInfos()

virtual tResult GetFrameSignalInfos ( tFrameID  nFrameId,
const ucom::nitro::ifunction< void(const tSignalInfo *pSignalInfo)> &  fnCallback 
) const
pure virtual

Returns the all frame specific signal information structure by the frame id.

Parameters
nFrameId[in] Frame Id
pFrameInfo[out] Frame information structure
Returns
Standard Result Code

◆ GetParentPdu()

virtual tResult GetParentPdu ( tPDUID  nChildPduId,
const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &  fnCallback 
) const
pure virtual

Returns all parent PDU infos which contain the child PDU id.

Parameters
nChildPduId[in] Child PDU Id
fnCallback[out] Callback function to get parent cluster PDU infos
Returns
Standard Result Code

◆ GetPduInfo()

virtual tResult GetPduInfo ( tPDUID  nPduId,
const tPduInfo **  pPduInfo 
) const
pure virtual

Returns the information structure for the specified pdu by its internal pdu id.

Parameters
nPduId[in] Pdu Id
pPduInfo[out] Pdu information structure
Returns
Standard Result Code

◆ GetPdusBySignal()

virtual tResult GetPdusBySignal ( tSignalID  nSignalId,
const ucom::nitro::ifunction< void(const tPduInfo *pPduInfo) > &  fnCallback 
) const
pure virtual

Returns all PDU infos which contain the signal id.

Parameters
nSignalId[in] Signal Id
fnCallback[out] Callback function to get appropriate cluster pdu infos
Returns
Standard Result Code

◆ GetReceiverEcusByFrame()

virtual tResult GetReceiverEcusByFrame ( tFrameID  nFrameId,
const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &  fnCallback 
) const
pure virtual

Returns all ECU infos which are received by the specified internal frame id.

Parameters
nFrameId[in] Frame Id
fnCallback[out] Callback function to get receiver cluster ECU infos
Returns
Standard Result Code

◆ GetSenderEcusByFrame()

virtual tResult GetSenderEcusByFrame ( tFrameID  nFrameId,
const ucom::nitro::ifunction< void(const tEcuInfo *pEcuInfo) > &  fnCallback 
) const
pure virtual

Returns all ECU infos which are sent by the specified internal frame id.

Parameters
nFrameId[in] Frame Id
fnCallback[out] Callback function to get sender cluster ECU infos
Returns
Standard Result Code

◆ GetSignalInfo() [1/2]

virtual tResult GetSignalInfo ( const char *  pstrSignal,
const tSignalInfo **  pSignalInfo 
) const
pure virtual

Returns the information structure about a signal by its signal name.

Parameters
pstrSignal[in] Signal name
pSignalInfo[out] Signal information
Returns
Standard Result Code

◆ GetSignalInfo() [2/2]

virtual tResult GetSignalInfo ( tSignalID  nSignalId,
const tSignalInfo **  pSignalInfo 
) const
pure virtual

Returns the information structure about a signal by its internal id.

Parameters
nSignalId[in] Signal Id
pSignalInfo[out] Signal information
Returns
Standard Result Code

◆ ResolveFrameInfo()

virtual tResult ResolveFrameInfo ( tMessageID  nMessageId,
const tFrameInfo **  pFrameInfo 
) const
pure virtual

Returns the information structure for the specified frame by its database message id.

Parameters
nMessageId[in] Message Id
pFrameInfo[out] Frame information structure
Returns
Standard Result Code