RTEventReception Class Reference

A static constraint on an event that should be received by a capsule that uses the RTMultiReceive utility for keeping track of multiple received events. More...

#include <RTEventReception.h>

Inheritance diagram for RTEventReception:

Public Member Functions
	RTEventReception (const RTProtocol *p=nullptr)
	Construction of RTEventReception.
	RTEventReception (const std::string &sigName, const RTProtocol *p=nullptr, const std::string &data="")
	Construction of RTEventReception.
	RTEventReception (const int &sig, const RTProtocol *p, const std::string &data="")
	Construction of RTEventReception.
virtual bool	match (const RTMessage *msg) override
	Match the received message with the data of this RTEventReception object.
virtual bool	match (const RTMessage *)=0
	Check if a received message matches the expectations on a received event as described in the concrete derived classes.

Detailed Description

A static constraint on an event that should be received by a capsule that uses the RTMultiReceive utility for keeping track of multiple received events.

The constraint lets you specify the event to be received (either by signal id or event name), the port on which it should be received, and the data it should carry (if any).

Constructor & Destructor Documentation

RTEventReception() [1/3]

RTEventReception::RTEventReception

(

const RTProtocol *

p = nullptr

)

Construction of RTEventReception.

Parameters

[in]

p

port on which the event must be received (if omitted it can be received on any port)

RTEventReception() [2/3]

RTEventReception::RTEventReception	(	const std::string &	sigName,
		const RTProtocol *	p = nullptr,
		const std::string &	data = ""
	)

Construction of RTEventReception.

Parameters

[in]	sigName	name of event that must be received
[in]	p	port on which the event must be received (if omitted it can be received on any port)
[in]	data	data (ASCII encoded) which the event must carry (if omitted it can have any or no data)

RTEventReception() [3/3]

RTEventReception::RTEventReception	(	const int &	sig,
		const RTProtocol *	p,
		const std::string &	data = ""
	)

Construction of RTEventReception.

Parameters

[in]	sig	signal id of event that must be received
[in]	p	port on which the event must be received
[in]	data	data (ASCII encoded) which the event must carry (if omitted it can have any or no data)

Member Function Documentation

match()

virtual bool RTEventReception::match ( const RTMessage *  msg )

overridevirtual

Match the received message with the data of this RTEventReception object.

Parameters

[in]

message

received by the owner capsule

Returns

true if the message matches, otherwise false

Implements RTEventReceptionInterface.

---

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

• RTEventReception.h