Inheritance diagram for ICANFDCoder:

[legend]

Public Member Functions
	ADTF_IID (ICANFDCoder, "canfd_coder.ignition.canfd.sdk.devicetb.adtf.iid")

virtual tResult	SetData (const tCANFDData *pData)=0
	Set a message from an input CAN FD sample. More...

virtual tResult	SetData (const adtf::devicetb::sdk::can::tCANData *pData)=0
	Set a message from an input CAN sample or raw data. More...

virtual tResult	CreateMessage (const tMessageID nMsgId, const tChannelID nChannelId)=0
	Create a new message. More...

virtual tResult	GetMessageData (tCANFDData *pMsgData)=0
	Return information about the CAN FD message. More...

virtual tResult	GetMessageData (adtf::devicetb::sdk::can::tCANData *pMsgData)=0
	Return information about the CAN message. More...

virtual tResult	GetMessageId (tMessageID &nMessageId) const =0
	Return the CAN FD message identifier without any flags. More...

virtual tResult	SetRawSignalValue (tSignalID nSignalId, const tSignalValue &oRawValue)=0
	Set a raw signal value given by the signal id. More...

virtual tResult	SetRawSignalValue (tSignalID nSignalId, const void *pRawValue, uint64_t nSize)=0
	Set a raw signal value byte array given by the signal id. More...

virtual tResult	SetPhysicalSignalValue (tSignalID nSignalId, double nPhysValue)=0
	Set a physical value given by the signal id. More...

virtual tResult	GetSignalValue (tSignalID nSignalId, tSignalValue &oRawValue, double &nPhysValue) const =0
	Return the decoded value of one CAN FD signal from the data area given by SetData or CreateMessage. More...

virtual tResult	GetSignalValue (tSignalID nSignalId, void *pRawValue, uint64_t nSize) const =0
	Return the decoded value of one CAN FD signal from the data area given by SetData or CreateMessage. More...

virtual tResult	SetRawData (const void *pData, uint8_t nLength)=0
	Copy the given CAN FD raw message payload to the payload of the message. More...

virtual tResult	GetDatabase (tChannelID nChannelId, adtf::ucom::ant::iobject_ptr< ICANFDDatabase > &pCANFDDatabase) const =0
	Return the CAN FD Database for the channel. More...

virtual tResult	GetAllSignalValues (const ucom::nitro::ifunction< void(tSignalID nSignalId, tSignalValue oRawValue, double nPhysValue)> &fnCallback) const =0
	Return all signal values from the current data buffer. More...

virtual tResult	GetMultiplexSelectorFieldCode (uint32_t &nSelectorFieldCode)=0
	Return the selector field code from the current data buffer. More...

virtual tResult	SetMultiplexSelectorFieldCode (uint32_t nSelectorFieldCode)=0
	Set the selector field code for the current data buffer. More...

Detailed Description

Definition at line 231 of file canfd_coder_intf.h.

Member Function Documentation

◆ CreateMessage()

virtual tResult CreateMessage	(	const tMessageID	nMsgId,
		const tChannelID	nChannelId
	)

pure virtual

Create a new message.

Parameters

[in]	nMsgId	Message Id of the new message
[in]	nChannelId	Channel Id from the message database

Return values

ERR_POINTER Any of the input arguments is a nullptr

◆ GetAllSignalValues()

virtual tResult GetAllSignalValues ( const ucom::nitro::ifunction< void(tSignalID nSignalId, tSignalValue oRawValue, double nPhysValue)> & fnCallback ) const

pure virtual

Return all signal values from the current data buffer.

Non active signals (for example from multiplexed frames) are skipped.

Parameters

[out] fnCallback Callback function returning decoded and raw values for each signal

Return values

ERR_MEMORY No buffer area was set or created

◆ GetDatabase()

virtual tResult GetDatabase	(	tChannelID	nChannelId,
		adtf::ucom::ant::iobject_ptr< ICANFDDatabase > &	pCANFDDatabase
	)		const

pure virtual

Return the CAN FD Database for the channel.

Parameters

[in]	nChannelId	CAN FD Channel number
[out]	pCANFDDatabase	Pointer to CAN database

Return values

ERR_OUT_OF_RANGE For the given channel no CAN database is defined

◆ GetMessageData() [1/2]

virtual tResult GetMessageData ( adtf::devicetb::sdk::can::tCANData * pMsgData )

pure virtual

Return information about the CAN message.

Parameters

[out] pMsgData Pointer to the CAN data structure

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_UNKNOWN_FORMAT	Buffer area is not compatible for CAN

◆ GetMessageData() [2/2]

virtual tResult GetMessageData ( tCANFDData * pMsgData )

pure virtual

Return information about the CAN FD message.

Parameters

[out] pMsgData Pointer to the CAN FD data structure

Return values

ERR_MEMORY No buffer area was set or the size is invalid

◆ GetMessageId()

virtual tResult GetMessageId ( tMessageID & nMessageId ) const

pure virtual

Return the CAN FD message identifier without any flags.

Parameters

[out] nMessageId Message identifier without any flags

Return values

ERR_MEMORY No buffer area was set or the size is invalid

◆ GetMultiplexSelectorFieldCode()

virtual tResult GetMultiplexSelectorFieldCode ( uint32_t & nSelectorFieldCode )

pure virtual

Return the selector field code from the current data buffer.

Parameters

[out] nSelectorFieldCode Selector Field Code

Return values

ERR_MEMORY No buffer area was set or created

◆ GetSignalValue() [1/2]

virtual tResult GetSignalValue	(	tSignalID	nSignalId,
		tSignalValue &	oRawValue,
		double &	nPhysValue
	)		const

pure virtual

Return the decoded value of one CAN FD signal from the data area given by SetData or CreateMessage.

oRawValue contains the non modified raw value. nPhysValue contains the decoded signal value and is set to std::numeric_limits<double>::quiet_NaN() if no decoding was possible.

Parameters

[in]	nSignalId	Value ID
[out]	oRawValue	Raw signal value
[out]	nPhysValue	Physical signal value (if not possible, std::numeric_limits<double>::quiet_NaN() is returned)

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_INVALID_INDEX	The given nSignalID is not in the current CAN FD message

◆ GetSignalValue() [2/2]

virtual tResult GetSignalValue	(	tSignalID	nSignalId,
		void *	pRawValue,
		uint64_t	nSize
	)		const

pure virtual

Return the decoded value of one CAN FD signal from the data area given by SetData or CreateMessage.

The pRawValue contains the non modified raw value as data array in original byte order. nSize represents the size of the raw value data array.

Parameters

[in]	nSignalId	Value ID
[out]	pRawValue	Raw signal value
[in]	nSize	Size of raw value array in bytes

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_INVALID_INDEX	The given nSignalID is not in the current CAN FD message

◆ SetData() [1/2]

virtual tResult SetData ( const adtf::devicetb::sdk::can::tCANData * pData )

pure virtual

Set a message from an input CAN sample or raw data.

Parameters

[in] pData Pointer to input message

retval ERR_POINTER pData must not be nullptr

◆ SetData() [2/2]

virtual tResult SetData ( const tCANFDData * pData )

pure virtual

Set a message from an input CAN FD sample.

Parameters

[in] pData Pointer to input message

retval ERR_POINTER pData must not be nullptr

◆ SetMultiplexSelectorFieldCode()

virtual tResult SetMultiplexSelectorFieldCode ( uint32_t nSelectorFieldCode )

pure virtual

Set the selector field code for the current data buffer.

Parameters

[in] nSelectorFieldCode Selector Field Code

Return values

ERR_MEMORY No buffer area was set or created

◆ SetPhysicalSignalValue()

virtual tResult SetPhysicalSignalValue	(	tSignalID	nSignalId,
		double	nPhysValue
	)

pure virtual

Set a physical value given by the signal id.

Parameters

[in]	nSignalId	Value ID
[in]	nPhysValue	Physical value to be written

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_INVALID_INDEX	The given nSignalID is not in the current CAN FD message
ERR_OUT_OF_RANGE	The given physical value violates the signal boundaries

◆ SetRawData()

virtual tResult SetRawData	(	const void *	pData,
		uint8_t	nLength
	)

pure virtual

Copy the given CAN FD raw message payload to the payload of the message.

Parameters

[in]	pData	Point of raw message payload to set
[in]	nLength	Length of raw message payload

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_POINTER	Any of the input arguments is a nullptr
ERR_INVALID_ARG	The specified length exceeds the message length

◆ SetRawSignalValue() [1/2]

virtual tResult SetRawSignalValue	(	tSignalID	nSignalId,
		const tSignalValue &	oRawValue
	)

pure virtual

Set a raw signal value given by the signal id.

Parameters

[in]	nSignalId	Value ID
[in]	oRawValue	Raw value to be written to CAN FD message

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_INVALID_INDEX	The given nSignalID is not in the current CAN FD message

◆ SetRawSignalValue() [2/2]

virtual tResult SetRawSignalValue	(	tSignalID	nSignalId,
		const void *	pRawValue,
		uint64_t	nSize
	)

pure virtual

Set a raw signal value byte array given by the signal id.

Parameters

[in]	nSignalId	Value ID
[in]	pRawValue	Raw data byte array (byte array was allocated from the caller and set in original byte order)
[in]	nSize	Size of the raw value byte array in bytes

Return values

ERR_MEMORY	No buffer area was set or the size is invalid
ERR_INVALID_INDEX	The given nSignalID is not in the current CAN FD message

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateMessage()

◆ GetAllSignalValues()

◆ GetDatabase()

◆ GetMessageData() [1/2]

◆ GetMessageData() [2/2]

◆ GetMessageId()

◆ GetMultiplexSelectorFieldCode()

◆ GetSignalValue() [1/2]

◆ GetSignalValue() [2/2]

◆ SetData() [1/2]

◆ SetData() [2/2]

◆ SetMultiplexSelectorFieldCode()

◆ SetPhysicalSignalValue()

◆ SetRawData()

◆ SetRawSignalValue() [1/2]

◆ SetRawSignalValue() [2/2]