#include <someip_database_intf.h>

Inheritance diagram for adtf::devicetb::sdk::someip::hood::ISomeIpDatabase:

Collaboration diagram for adtf::devicetb::sdk::someip::hood::ISomeIpDatabase:

Public Member Functions
	ADTF_IID (ISomeIpDatabase, "someip_database.hood.someip.sdk.devicetb.adtf.iid")
	Interface ID for the SOME/IP database interface.

virtual tResult	GetMessageInfo (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader &oMessageHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const =0

virtual tResult	GetClusterInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tClusterInfo *pClusterInfo) > &fnCallback) const =0

virtual tResult	GetEcus (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) > &fnCallback) const =0

virtual tResult	GetChannelsByCluster (uint32_t nClusterId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tChannelInfo *pChannelInfo) > &fnCallback) const =0

virtual tResult	GetCluster (uint32_t nClusterId, const adtf::devicetb::sdk::someip::hood::tClusterInfo *&pClusterInfo) const =0

virtual tResult	GetEcu (uint32_t nEcuId, const adtf::devicetb::sdk::someip::hood::tECUInfo *&pECUInfo) const =0

virtual tResult	GetChannel (uint32_t nChannelId, const adtf::devicetb::sdk::someip::hood::tChannelInfo *&pChannelInfo) const =0

virtual tResult	GetSenderEcu (const tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) const =0

virtual tResult	GetMessageInfo (uint32_t nMessageInfoId, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const =0

virtual tResult	GetConnectionsByEcu (uint32_t nEcuId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0

virtual tResult	GetConnectionsByChannel (uint32_t nChannelId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0

virtual tResult	GetMessageInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *pMessageInfo) > &fnCallback) const =0

virtual bool	ConnectionContainsSomeIp (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oEthernetHeader) const =0

Detailed Description

The ISomeIpDatabase interface provides access to SOME/IP specific information contained in a database file such as FIBEX or ARXML.

Member Function Documentation

◆ ConnectionContainsSomeIp()

virtual bool adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::ConnectionContainsSomeIp ( const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader & oEthernetHeader ) const

pure virtual

Check if a given ethernet sample is on a connection handled by this database. Only connection properties are checked, use GetMessageInfo instead to also test for message properties.

Parameters

[in] oEthernetHeader Ethernet sample header of ethernet frame.

Returns: Any defined connection can contain this sample.

◆ GetChannel()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetChannel	(	uint32_t	nChannelId,
		const adtf::devicetb::sdk::someip::hood::tChannelInfo *&	pChannelInfo ) const

pure virtual

Getter for a tChannelInfo with a given Id.

Parameters

[in]	nChannelId	The Id of the Channel.
[out]	pChannelInfo	The info of the channel. Ownership of pChannelInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetChannelsByCluster()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetChannelsByCluster	(	uint32_t	nClusterId,
		const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tChannelInfo *pChannelInfo) > &	fnCallback ) const

pure virtual

Returns all Channel Infos from a cluster.

Parameters

[in]	nClusterId	The Id of the Cluster.
[in]	fnCallback	function returning the tChannelInfo's from a cluster described in the loaded ARXML. Ownership of pChannelInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetCluster()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetCluster	(	uint32_t	nClusterId,
		const adtf::devicetb::sdk::someip::hood::tClusterInfo *&	pClusterInfo ) const

pure virtual

Getter for a tClusterInfo with a given Id.

Parameters

[in]	nClusterId	The Id of the Cluster.
[out]	pClusterInfo	The info of the cluster. Ownership of pClusterInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetClusterInfos()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetClusterInfos ( const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tClusterInfo *pClusterInfo) > & fnCallback ) const

pure virtual

Returns all Cluster Infos.

Parameters

[in] fnCallback function returning the tClusterInfo's described in the loaded ARXML. Ownership of pClusterInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetConnectionsByChannel()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetConnectionsByChannel	(	uint32_t	nChannelId,
		const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &	fnCallback ) const

pure virtual

Getter for the sockets connected with a channel.

Parameters

[in]	nChannelId	The channel Id.
[in]	fnCallback	function returning the tSomeIpSocketInfo's. Ownership of pSocketInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetConnectionsByEcu()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetConnectionsByEcu	(	uint32_t	nEcuId,
		const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &	fnCallback ) const

pure virtual

Getter for the sockets connected with an ecu

Parameters

[in]	nEcuId	The channel Id.
[in]	fnCallback	function returning the tSomeIpSocketInfo's. Ownership of pSocketInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetEcu()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetEcu	(	uint32_t	nEcuId,
		const adtf::devicetb::sdk::someip::hood::tECUInfo *&	pECUInfo ) const

pure virtual

Getter for a tEcuInfo with a given Id.

Parameters

[in]	nEcuId	The Id of the ECU.
[out]	pECUInfo	The info of the ECU. Ownership of pECUInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetEcus()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetEcus ( const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) > & fnCallback ) const

pure virtual

Returns all Ecu Infos from a cluster.

Parameters

[in] fnCallback function returning the tECUInfo's from a cluster described in the loaded ARXML. Ownership of pECUInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetMessageInfo() [1/2]

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetMessageInfo	(	const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &	oSampleHeader,
		const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader &	oMessageHeader,
		const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&	pMessageInfo ) const

pure virtual

Returns the SOME/IP Message Info for a given SOME/IP message sample and message header.

Parameters

[in]	oSampleHeader	The SOME/IP Sample Header.
[in]	oMessageHeader	The header of the SOME/IP message.
[out]	pMessageInfo	The message info of the SOME/IP message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

Implemented in adtf::devicetb::sdk::someip::key::ISomeIpDatabase.

◆ GetMessageInfo() [2/2]

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetMessageInfo	(	uint32_t	nMessageInfoId,
		const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&	pMessageInfo ) const

pure virtual

Getter for a tSomeIpMessageInfo with a given Id.

Parameters

[in]	nMessageInfoId	The Id of the message.
[out]	pMessageInfo	The Info of the Message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

Implemented in adtf::devicetb::sdk::someip::key::ISomeIpDatabase.

◆ GetMessageInfos()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetMessageInfos ( const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *pMessageInfo) > & fnCallback ) const

pure virtual

Getter for all SOME/IP messages.

Parameters

[in] fnCallback function returning the tSomeIpMessageInfo's. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

◆ GetSenderEcu()

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetSenderEcu	(	const tSomeIpSampleHeader &	oSampleHeader,
		const adtf::devicetb::sdk::someip::hood::tECUInfo *	pECUInfo ) const

pure virtual

Getter for the sender ECU.

Parameters

[in]	oSampleHeader	The SOME/IP sample header from the SOME/IP message.
[out]	pECUInfo	The Info of the sender ECU. Ownership of pECUInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns: tResult

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

include/sdk/someip_database_intf.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ ConnectionContainsSomeIp()

◆ GetChannel()

◆ GetChannelsByCluster()

◆ GetCluster()

◆ GetClusterInfos()

◆ GetConnectionsByChannel()

◆ GetConnectionsByEcu()

◆ GetEcu()

◆ GetEcus()

◆ GetMessageInfo() [1/2]

◆ GetMessageInfo() [2/2]

◆ GetMessageInfos()

◆ GetSenderEcu()