#include <can_database_intf.h>

Inheritance diagram for adtf::devicetb::sdk::can::axle::ICANDatabase:

Collaboration diagram for adtf::devicetb::sdk::can::axle::ICANDatabase:

Public Member Functions
	ADTF_IID (ICANDatabase, "can_database.axle.can.sdk.devicetb.adtf.iid")

virtual tResult	GetMessageCount (uint32_t *pnMessageCount) const =0

virtual tResult	GetMessageID (const char strMessageName, tMessageID pnMessageID, bool *pbExtended) const =0

virtual tResult	GetMessageName (tMessageID nMessageID, bool bExtended, const char **pMessageName) const =0

virtual tResult	GetMessageInfo (tMessageID nMessageID, bool bExtended, const tMessageInfo **pMessageInfo) const =0

virtual tResult	GetSignalCount (uint32_t *pnSignalCount) const =0

virtual tResult	GetSignalID (const char strSignalName, tSignalID pnSignalID) const =0

virtual tResult	GetSignalName (tSignalID nSignalID, const char **pSignalName) const =0

virtual tResult	GetSignalUnit (tSignalID nSignalID, const char **pSignalUnit) const =0

virtual tResult	GetSignalDescription (tSignalID nSignalID, const char **pSignalDescription) const =0

virtual tResult	GetSignalInfo (tSignalID nSignalID, const tSignalInfo **pSignalInfo) const =0

virtual tResult	GetNetworkNodes (std::vector< const char * > &astrNetworkNodes) const =0

virtual tResult	GetNetworkNames (std::vector< const char * > &astrNetworkNames) const =0

Detailed Description

The ICANDatabase interface

Member Function Documentation

◆ GetMessageCount()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetMessageCount ( uint32_t * pnMessageCount ) const

pure virtual

Returns the count of Messages described in this DBC

Parameters

pnMessageCount [out] Count of Messages

Returns: Standard Result Code

◆ GetMessageID()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetMessageID	(	const char *	strMessageName,
		tMessageID *	pnMessageID,
		bool *	pbExtended ) const

pure virtual

Retrieves the ID of a Message

Parameters

strMessageName	[in] Name of Message
pnMessageID	[out] Message ID
pbExtended	[out] True if message is an extended CAN message, otherwise false

Returns: Standard Result Code

◆ GetMessageInfo()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetMessageInfo	(	tMessageID	nMessageID,
		bool	bExtended,
		const tMessageInfo **	pMessageInfo ) const

pure virtual

Returns the information structure for the specified message

Parameters

nMessageID	[in] Message ID
bExtended	[in] True if message is an extended CAN message, otherwise false
pMessageInfo	[out] Reference of pointer to the structure.

Returns: Standard Result Code

◆ GetMessageName()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetMessageName	(	tMessageID	nMessageID,
		bool	bExtended,
		const char **	pMessageName ) const

pure virtual

Retrieves the name of a Message.

Parameters

nMessageID	[in] Message ID
bExtended	[in] True if message is an extended CAN message, otherwise false
pMessageName	[out] Name of Message

Returns: Standard Result Code

◆ GetNetworkNames()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetNetworkNames ( std::vector< const char * > & astrNetworkNames ) const

pure virtual

Returns an array of names of all CAN networks

Parameters

astrNetworkNames [out] vector of CAN network names

Returns: Standard Result Code

Note: Added in version 2.1.0

◆ GetNetworkNodes()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetNetworkNodes ( std::vector< const char * > & astrNetworkNodes ) const

pure virtual

Returns an array of names of all network nodes

Parameters

astrNetworkNodes [out] vector of network node names

Returns: Standard Result Code

Note: Added in version 2.1.0

◆ GetSignalCount()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalCount ( uint32_t * pnSignalCount ) const

pure virtual

Returns the count of signals described in this database.

Parameters

pnSignalCount [out] Count of signals

Returns: Standard Result Code

◆ GetSignalDescription()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalDescription	(	tSignalID	nSignalID,
		const char **	pSignalDescription ) const

pure virtual

Returns the description of a signal

Parameters

nSignalID	[in] Signal ID
pSignalDescription	[out] Pointer to pointer variable of signal description

Returns: Standard Result Code

◆ GetSignalID()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalID	(	const char *	strSignalName,
		tSignalID *	pnSignalID ) const

pure virtual

Returns the ID of a signal

Parameters

strSignalName	[in] Signal Name
pnSignalID	[out] Pointer to variable of signal ID

Returns: Standard Result Code

◆ GetSignalInfo()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalInfo	(	tSignalID	nSignalID,
		const tSignalInfo **	pSignalInfo ) const

pure virtual

Returns information about a signal

Parameters

nSignalID	[in] Signal ID
pSignalInfo	[out] Pointer to pointer variable of signal information

Returns: Standard Result Code

◆ GetSignalName()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalName	(	tSignalID	nSignalID,
		const char **	pSignalName ) const

pure virtual

Returns the name of a signal

Parameters

nSignalID	[in] Signal ID
pSignalName	[out] Pointer to pointer variable of signal name

Returns: Standard Result Code

◆ GetSignalUnit()

virtual tResult adtf::devicetb::sdk::can::axle::ICANDatabase::GetSignalUnit	(	tSignalID	nSignalID,
		const char **	pSignalUnit ) const

pure virtual

Returns the unito of a signal

Parameters

nSignalID	[in] Signal ID
pSignalUnit	[out] Pointer to pointer variable of signal unit

Returns: Standard Result Code

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

include/sdk/can_database_intf.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetMessageCount()

◆ GetMessageID()

◆ GetMessageInfo()

◆ GetMessageName()

◆ GetNetworkNames()

◆ GetNetworkNodes()

◆ GetSignalCount()

◆ GetSignalDescription()

◆ GetSignalID()

◆ GetSignalInfo()

◆ GetSignalName()

◆ GetSignalUnit()