Interface of FIBEX database. More...

Inheritance diagram for IFlexRayDatabase:

Public Member Functions
	ADTF_IID (IFlexRayDatabase, "flexray_database.axle.flexray.sdk.devicetb.adtf.iid")
	Interface ID for the fibex database service interface.

virtual const char *	GetName () const =0
	Returns the name of the database. More...

virtual tResult	GetClusterConfig (tClusterConfig *pCluster)=0
	Returns information about the cluster. More...

virtual tResult	GetChannelName (tChannelID nChannel, const char **pChannelName) const =0
	Returns the name of a channel. More...

virtual tResult	GetECUCount (uint32_t *pnECUCount) const =0
	Returns the count of ECUs. More...

virtual tResult	GetECUName (tECUID nECUID, const char **pECUName) const =0
	Retrieves the name of an ECU. More...

virtual tResult	GetECUID (const char strECUName, tECUID pnECUID) const =0
	Retrieves the ID of an ECU. More...

virtual tResult	GetECUInfo (tECUID nECUID, const tECUInfo **pECUInfo) const =0
	Retrieves the ID of an ECU. More...

virtual tResult	GetECUConfig (const char strECU, tECUConfig pECUConfig)=0
	Returns the configuration information of a ECU. More...

virtual tResult	GetSignalCount (uint32_t *pnSignalCount) const =0
	Returns the count of signals described in this FIBEX database. More...

virtual tResult	GetSignalName (tSignalID nSignalID, const char **pSignalName) const =0
	Returns the name of a signal. More...

virtual tResult	GetSignalUnit (tSignalID nSignalID, const char **pSignalUnit) const =0
	Returns the unito of a signal. More...

virtual tResult	GetSignalDescription (tSignalID nSignalID, const char **pSignalDescription) const =0
	Returns the description of a signal. More...

virtual tResult	GetSignalInfo (tSignalID nSignalID, const tSignalInfo **pSignalInfo) const =0
	Returns information about a signal. More...

virtual tResult	GetPDUCount (uint32_t *pnPDUCount) const =0
	Returns the count of PDUs described in this FIBEX database. More...

virtual tResult	GetPDUID (const char strPDUName, tPDUID pnPDUID) const =0
	Retrieves the ID of a PDU. More...

virtual tResult	GetPDUName (tPDUID nPDUID, const char **pPDUName) const =0
	Retrieves the name of a PDU. More...

virtual tResult	GetPDUInfo (tPDUID nPDUID, const tPDUInfo **pPDUInfo) const =0
	Retrieves the count of PDU of a frame. More...

virtual tResult	GetPDUSignalMap (tPDUID nPDUID, uint32_t nSignalCount, const tSignalID *pSignalMap) const =0
	Returns the map of signals for a PDU. More...

virtual tResult	GetSignalID (const char strSignalName, tSignalID pnSignalID) const =0
	Retrieves the ID of a signal. More...

virtual tResult	GetFrameInfo (tChannelID nChannel, tCycleID nCycle, tSlotID nSlot, const tFrameInfo **pFrameInfo) const =0
	Returns information about a frame. More...

virtual tResult	GetCycleInfo (tChannelID nChannel, tCycleID nCycle, const tCycleInfo **pCycleInfo) const =0
	Returns information about a cycle. More...

virtual tResult	GetChannelsForECU (tECUID nECUID, tChannelID *pChannelIDs, uint8_t pChannelCount) const =0
	Get the Channel ID's of all Channels this ECU is connected to. More...

virtual tResult	GetClusterConfig (tChannelID nChannelID, tClusterConfig *pConfig)=0
	Gets the cluster configuration. More...

virtual tResult	GetSignalPDUMappingConfig (tChannelID nChannelID, tSignalPDUMappingConfig *pConfig)=0
	Gets the Signal / PDUMapping configuration. More...

virtual tResult	GetClusterName (tChannelID nChannelID, const char **strClusterName)=0
	Gets the name of the cluster with ID nChannelID. More...

virtual tResult	GetNetworkID (const char strClusterName, tNetworkID nNetworkID)=0
	Gets the tNetwork ID of the cluster/network with short-name strClusterName. More...

virtual tResult	SetChannelID (tNetworkID nNetworkID, tChannelABID nChannelABID, tChannelID *pChannelID) const =0
	Creates the ChannelID (see tChannelID) from a tNetworkID and tChannelABID. More...

virtual tResult	GetNetworkID (tChannelID nChannelID, tNetworkID *pNetworkID) const =0
	Returns the tNetworkID which is contained in a tChannelID. More...

virtual tResult	GetChannelABID (tChannelID nChannelID, tChannelABID *pChannelABID) const =0
	Returns the tChannelABID which is contained in a tChannelID. More...

virtual tResult	GetAllClusterNames (tClusterNameLst *pClusterNames)=0
	Returns the Short-Names of all Clusters. More...

virtual tResult	GetAllECUNames (const char strProjectID, tECUNameLst pECUNames)=0
	Returns the Short-Names of all ECU. More...

virtual tResult	GetProjectID (const char strFileName, const char *strProjectID)=0
	Returns the Project ID of a FIBEX-File. More...

Detailed Description

Interface of FIBEX database.

Definition at line 511 of file flexray_database_intf.h.

Member Function Documentation

◆ GetAllClusterNames()

virtual tResult GetAllClusterNames ( tClusterNameLst * pClusterNames )

pure virtual

Returns the Short-Names of all Clusters.

Parameters

[out] pClusterNames - Contains a list of all Cluster-Names and the size of the list

Return values

ERR_INVALID_FILE if no cluster was found in Fibex-File(s)

◆ GetAllECUNames()

virtual tResult GetAllECUNames	(	const char *	strProjectID,
		tECUNameLst *	pECUNames
	)

pure virtual

Returns the Short-Names of all ECU.

Parameters

[out] pECUNames - Contains a list of all ECU-Names and the size of the list

Return values

ERR_POINTER if any pointer is a nullptr

◆ GetChannelABID()

virtual tResult GetChannelABID	(	tChannelID	nChannelID,
		tChannelABID *	pChannelABID
	)		const

pure virtual

Returns the tChannelABID which is contained in a tChannelID.

Parameters

[in]	nChannelID	- the internal ID of the Channel (cluster and A/B channel)
[out]	pChannelABID	- tChannelABID which is contained in a tChannelID

Return values

ERR_POINTER if pChannelABID is NULL-Pointer

◆ GetChannelName()

virtual tResult GetChannelName	(	tChannelID	nChannel,
		const char **	pChannelName
	)		const

pure virtual

Returns the name of a channel.

Parameters

nChannel	[in] Channel ID
pChannelName	[out] Pointer to pointer variable of channel name

Returns: Standard Result Code

◆ GetChannelsForECU()

virtual tResult GetChannelsForECU	(	tECUID	nECUID,
		tChannelID **	pChannelIDs,
		uint8_t *	pChannelCount
	)		const

pure virtual

Get the Channel ID's of all Channels this ECU is connected to.

Parameters

[in]	nECUID	- the ID of the ECU
[out]	pChannelIDs	- Pointer to Array of all ChannelIDs, the ECU is connected to
[out]	pChannelCount	- Number of Channels connected to this ECU

◆ GetClusterConfig() [1/2]

virtual tResult GetClusterConfig	(	tChannelID	nChannelID,
		tClusterConfig *	pConfig
	)

pure virtual

Gets the cluster configuration.

Parameters

[out]	pConfig	- the cluster configuration
[in]	nChannelID	- the Network/ClusterID is part of nChannelID, see tChannelID

Return values

ERR_INVALID_FILE if parsing failed

◆ GetClusterConfig() [2/2]

virtual tResult GetClusterConfig ( tClusterConfig * pCluster )

pure virtual

Returns information about the cluster.

Parameters

pCluster [out] Pointer to information structure

Returns: Standard Result Code

◆ GetClusterName()

virtual tResult GetClusterName	(	tChannelID	nChannelID,
		const char **	strClusterName
	)

pure virtual

Gets the name of the cluster with ID nChannelID.

Parameters

[out]	strClusterName	- the Short-Name of the Cluster
[in]	nChannelID	- the Network/ClusterID is part of nChannelID, see tChannelID

Return values

ERR_INVALID_FILE if parsing failed

◆ GetCycleInfo()

virtual tResult GetCycleInfo	(	tChannelID	nChannel,
		tCycleID	nCycle,
		const tCycleInfo **	pCycleInfo
	)		const

pure virtual

Returns information about a cycle.

Parameters

nChannel	[in] Channel
nCycle	[in] Cycle
pCycleInfo	[out] Pointer to the information structure

Returns: Standard Result Code

◆ GetECUConfig()

virtual tResult GetECUConfig	(	const char *	strECU,
		tECUConfig *	pECUConfig
	)

pure virtual

Returns the configuration information of a ECU.

Parameters

strECU	[in]
pECUConfig	[out]

Returns: Standard Result Code

◆ GetECUCount()

virtual tResult GetECUCount ( uint32_t * pnECUCount ) const

pure virtual

Returns the count of ECUs.

Parameters

pnECUCount [out] Pointer to variable of ECU count

Returns: Standard Result Code

◆ GetECUID()

virtual tResult GetECUID	(	const char *	strECUName,
		tECUID *	pnECUID
	)		const

pure virtual

Retrieves the ID of an ECU.

Parameters

strECUName	[in] Name of ECU
pnECUID	[out] ID of ECU.

Returns: Standard Result Code

◆ GetECUInfo()

virtual tResult GetECUInfo	(	tECUID	nECUID,
		const tECUInfo **	pECUInfo
	)		const

pure virtual

Retrieves the ID of an ECU.

Parameters

nECUID	[in] ID of ECU.
pECUInfo	[out] Pointer to pointer variable of ECU information

Returns: Standard Result Code

◆ GetECUName()

virtual tResult GetECUName	(	tECUID	nECUID,
		const char **	pECUName
	)		const

pure virtual

Retrieves the name of an ECU.

Parameters

nECUID	[in] ID of ECU.
pECUName	[out] Name of ECU.

Returns: Standard Result Code

◆ GetFrameInfo()

virtual tResult GetFrameInfo	(	tChannelID	nChannel,
		tCycleID	nCycle,
		tSlotID	nSlot,
		const tFrameInfo **	pFrameInfo
	)		const

pure virtual

Returns information about a frame.

Parameters

nChannel	[in] Channel ID
nCycle	[in] Cycle ID
nSlot	[in] Slot ID
pFrameInfo	[out] Pointer to the information structure

Returns: Standard Result Code

◆ GetName()

virtual const char* GetName ( ) const

pure virtual

Returns the name of the database.

Returns: const char*

◆ GetNetworkID() [1/2]

virtual tResult GetNetworkID	(	const char *	strClusterName,
		tNetworkID *	nNetworkID
	)

pure virtual

Gets the tNetwork ID of the cluster/network with short-name strClusterName.

Parameters

[out]	strClusterName	- the Short-Name of the Cluster
[in]	nNetworkID	- the Network/ClusterID is part of nChannelID, see tChannelID

Return values

ERR_NOT_FOUND if parsing failed

◆ GetNetworkID() [2/2]

virtual tResult GetNetworkID	(	tChannelID	nChannelID,
		tNetworkID *	pNetworkID
	)		const

pure virtual

Returns the tNetworkID which is contained in a tChannelID.

Parameters

[in]	nChannelID	- the internal ID of the Channel (cluster and A/B channel)
[out]	pNetworkID	- tNetworkID which is contained in a tChannelID

Return values

ERR_POINTER if pNetworkID is NULL-Pointer

◆ GetPDUCount()

virtual tResult GetPDUCount ( uint32_t * pnPDUCount ) const

pure virtual

Returns the count of PDUs described in this FIBEX database.

Parameters

pnPDUCount [out] Count of PDUs

Returns: Standard Result Code

◆ GetPDUID()

virtual tResult GetPDUID	(	const char *	strPDUName,
		tPDUID *	pnPDUID
	)		const

pure virtual

Retrieves the ID of a PDU.

Parameters

strPDUName	[in] Name of PDU
pnPDUID	[out] PDU ID

Returns: Standard Result Code

◆ GetPDUInfo()

virtual tResult GetPDUInfo	(	tPDUID	nPDUID,
		const tPDUInfo **	pPDUInfo
	)		const

pure virtual

Retrieves the count of PDU of a frame.

Parameters

nPDUID	[in] PDU ID
pPDUInfo	[out] Reference of pointer to the structure.

Returns: Standard Result Code

◆ GetPDUName()

virtual tResult GetPDUName	(	tPDUID	nPDUID,
		const char **	pPDUName
	)		const

pure virtual

Retrieves the name of a PDU.

Parameters

nPDUID	[in] PDU ID
pPDUName	[out] Name of PDU

Returns: Standard Result Code

◆ GetPDUSignalMap()

virtual tResult GetPDUSignalMap	(	tPDUID	nPDUID,
		uint32_t *	nSignalCount,
		const tSignalID **	pSignalMap
	)		const

pure virtual

Returns the map of signals for a PDU.

Parameters

nPDUID	[in] PDU ID
nSignalCount	[out] Address of integer receiving count of signals
pSignalMap	[out] Address of integer pointer, receiving address of signal index array. (May be NULL)

Returns: Standard Result Code

◆ GetProjectID()

virtual tResult GetProjectID	(	const char *	strFileName,
		const char **	strProjectID
	)

pure virtual

Returns the Project ID of a FIBEX-File.

Parameters

[in]	strFileName	- The name of the FIBEX-File
[out]	strProjectID	- Project ID (string) of the FIBEX-File

Return values

ERR_NOT_FOUND if no Project ID was found for this FIBEX-File

◆ GetSignalCount()

virtual tResult GetSignalCount ( uint32_t * pnSignalCount ) const

pure virtual

Returns the count of signals described in this FIBEX database.

Parameters

pnSignalCount [out] Count of signals

Returns: Standard Result Code

◆ GetSignalDescription()

virtual tResult 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 GetSignalID	(	const char *	strSignalName,
		tSignalID *	pnSignalID
	)		const

pure virtual

Retrieves the ID of a signal.

Parameters

strSignalName	[in] name of signal
pnSignalID	[out] Address of integer receiving signal ID

Returns: Standard Result Code

Note: ECU/Channel/Frame/Signal/<ProjectID>; ECU/Channel/PDU/Signal/<ProjectID>

◆ GetSignalInfo()

virtual tResult 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 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

◆ GetSignalPDUMappingConfig()

virtual tResult GetSignalPDUMappingConfig	(	tChannelID	nChannelID,
		tSignalPDUMappingConfig *	pConfig
	)

pure virtual

Gets the Signal / PDUMapping configuration.

Parameters

[out]	pConfig	- the Signal / PDUMapping configuration
[in]	nChannelID	- the Network/ClusterID is part of nChannelID, see tChannelID

Return values

ERR_INVALID_FILE if parsing failed

◆ GetSignalUnit()

virtual tResult 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

◆ SetChannelID()

virtual tResult SetChannelID	(	tNetworkID	nNetworkID,
		tChannelABID	nChannelABID,
		tChannelID *	pChannelID
	)		const

pure virtual

Creates the ChannelID (see tChannelID) from a tNetworkID and tChannelABID.

Parameters

[in]	nNetworkID	- the ID of the cluster/network
[in]	nChannelABID	- the ID of the Channel (A or B)
[out]	pChannelID	- Created tChannelID. First four Bit contain the nNetworkID. Last four Bit contain the nChannelABID

Return values

ERR_POINTER if pChannelID is NULL-Pointer

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAllClusterNames()

◆ GetAllECUNames()

◆ GetChannelABID()

◆ GetChannelName()

◆ GetChannelsForECU()

◆ GetClusterConfig() [1/2]

◆ GetClusterConfig() [2/2]

◆ GetClusterName()

◆ GetCycleInfo()

◆ GetECUConfig()

◆ GetECUCount()

◆ GetECUID()

◆ GetECUInfo()

◆ GetECUName()

◆ GetFrameInfo()

◆ GetName()

◆ GetNetworkID() [1/2]

◆ GetNetworkID() [2/2]

◆ GetPDUCount()

◆ GetPDUID()

◆ GetPDUInfo()

◆ GetPDUName()

◆ GetPDUSignalMap()

◆ GetProjectID()

◆ GetSignalCount()

◆ GetSignalDescription()

◆ GetSignalID()

◆ GetSignalInfo()

◆ GetSignalName()

◆ GetSignalPDUMappingConfig()

◆ GetSignalUnit()

◆ SetChannelID()