Helper for sending messages to an active part. More...

#include <Imt.Base.Dff.UnitTest.Helper/inc/Imt.Base.Dff.UnitTest.Helper/ActivePartHelper.h>

Inheritance diagram for unitTestHelper::ActivePartHelper:

Static Public Member Functions
static void	sendSignal (::imt::base::dff::activeparts::test::ChannelMockIn *const pChannelIn, uint16_t const protocolIdentifier)
	Sends a signal over the channelIn.

static void	sendMessage (::imt::base::dff::activeparts::test::ChannelMockIn *const pChannelIn, uint16_t const protocolIdentifier, ::imt::base::core::serialization::SerializableIfc const &pMessage)
	Sends a single message over the channelIn.

static void	assertNoMessage (::imt::base::dff::activeparts::test::ChannelMockOut *const channelOut)
	Check if no message was sent on the given output channel.

static void	assertMessage (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, size_t pos, uint16_t const expectedProtocol)
	Check if the message at the given position has the given protocol identifier.

template<typename MessageType >
static void	assertMessage (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, size_t pos, uint16_t const expectedProtocol, MessageType const &expectedMessage)
	Check if the message at the given position has the given protocol identifier and message data.

static void	assertNextMessage (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, uint16_t const expectedProtocol)
	Check if the oldest message on the channel has the given protocol identifier.

template<typename MessageType >
static void	assertNextMessage (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, uint16_t const expectedProtocol, MessageType const &expectedMessage)
	Check if the oldest message on the channel has the given protocol identifier and message data.

static void	assertNextMessageAndPop (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, uint16_t const expectedProtocol)
	Check if the oldest message on the channel has the given protocol identifier and dequeues the message.

template<typename MessageType >
static void	assertNextMessageAndPop (::imt::base::dff::activeparts::test::ChannelMockOut *const pChannelOut, uint16_t const expectedProtocol, MessageType const &expectedMessage)
	Check if the oldest message on the channel has the given protocol identifier and message data and dequeues the message.

Detailed Description

Helper for sending messages to an active part.

Definition at line 16 of file ActivePartHelper.h.

Member Function Documentation

◆ assertMessage() [1/2]

static void unitTestHelper::ActivePartHelper::assertMessage	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		size_t	pos,
		uint16_t const	expectedProtocol
	)

static

Check if the message at the given position has the given protocol identifier.

Parameters

pChannelOut	The channel to check for messages.
pos	The message at the given position in the queue is checked.
expectedProtocol	The protocol identifier to verify.

◆ assertMessage() [2/2]

template<typename MessageType >

static void unitTestHelper::ActivePartHelper::assertMessage	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		size_t	pos,
		uint16_t const	expectedProtocol,
		MessageType const &	expectedMessage
	)

inlinestatic

Check if the message at the given position has the given protocol identifier and message data.

Parameters

pChannelOut	The channel to check for messages.
pos	The message at the given position in the queue is checked.
expectedProtocol	The protocol identifier to verify.
expectedMessage	The message to verify against.

Definition at line 57 of file ActivePartHelper.h.

◆ assertNextMessage() [1/2]

static void unitTestHelper::ActivePartHelper::assertNextMessage	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		uint16_t const	expectedProtocol
	)

static

Check if the oldest message on the channel has the given protocol identifier.

Parameters

pChannelOut	The channel to check for messages.
expectedProtocol	The protocol identifier to verify.

◆ assertNextMessage() [2/2]

template<typename MessageType >

static void unitTestHelper::ActivePartHelper::assertNextMessage	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		uint16_t const	expectedProtocol,
		MessageType const &	expectedMessage
	)

inlinestatic

Check if the oldest message on the channel has the given protocol identifier and message data.

Parameters

pChannelOut	The channel to check for messages.
expectedProtocol	The protocol identifier to verify.
expectedMessage	The message to verify against.

Definition at line 79 of file ActivePartHelper.h.

◆ assertNextMessageAndPop() [1/2]

static void unitTestHelper::ActivePartHelper::assertNextMessageAndPop	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		uint16_t const	expectedProtocol
	)

static

Check if the oldest message on the channel has the given protocol identifier and dequeues the message.

Parameters

pChannelOut	The channel to check for messages.
expectedProtocol	The protocol identifier to verify.

◆ assertNextMessageAndPop() [2/2]

template<typename MessageType >

static void unitTestHelper::ActivePartHelper::assertNextMessageAndPop	(	::imt::base::dff::activeparts::test::ChannelMockOut *const	pChannelOut,
		uint16_t const	expectedProtocol,
		MessageType const &	expectedMessage
	)

inlinestatic

Check if the oldest message on the channel has the given protocol identifier and message data and dequeues the message.

Parameters

pChannelOut	The channel to check for messages.
expectedProtocol	The protocol identifier to verify.
expectedMessage	The message to verify against.

Definition at line 97 of file ActivePartHelper.h.

◆ assertNoMessage()

static void unitTestHelper::ActivePartHelper::assertNoMessage ( ::imt::base::dff::activeparts::test::ChannelMockOut *const channelOut )

static

Check if no message was sent on the given output channel.

Parameters

channelOut The channel to check for messages.

◆ sendMessage()

static void unitTestHelper::ActivePartHelper::sendMessage	(	::imt::base::dff::activeparts::test::ChannelMockIn *const	pChannelIn,
		uint16_t const	protocolIdentifier,
		::imt::base::core::serialization::SerializableIfc const &	pMessage
	)

static

Sends a single message over the channelIn.

Parameters

pChannelIn	The passed message is send over this channel.
protocolIdentifier	The protocol identifier of the message.
pMessage	the message to be send.

◆ sendSignal()

static void unitTestHelper::ActivePartHelper::sendSignal	(	::imt::base::dff::activeparts::test::ChannelMockIn *const	pChannelIn,
		uint16_t const	protocolIdentifier
	)

static

Sends a signal over the channelIn.

Parameters

pChannelIn	The passed message is send over this channel.
protocolIdentifier	The protocol identifier of the signal.

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

C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.UnitTest.Helper/inc/Imt.Base.Dff.UnitTest.Helper/ActivePartHelper.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ assertMessage() [1/2]

◆ assertMessage() [2/2]

◆ assertNextMessage() [1/2]

◆ assertNextMessage() [2/2]

◆ assertNextMessageAndPop() [1/2]

◆ assertNextMessageAndPop() [2/2]

◆ assertNoMessage()

◆ sendMessage()

◆ sendSignal()