Messages can be sent on the output port. More...

#include <Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/PortOutput.h>

Inheritance diagram for imt::base::dff::activeparts::PortOutput:

Public Member Functions
	PortOutput ()=default
	Constructor.

void	write (uint16_t const protocolIdentifier, ::imt::base::core::serialization::SerializableIfc const *const pEventData, size_t const eventDataSizeBytes) final
	Write data to port (is sent via the ChannelIfc)

virtual void	setChannel (ChannelIfc &channel)
	Set the channel to transport the message.

ChannelIfc const *	getChannel () const
	Get the read only pointer to the channel.

Public Member Functions inherited from imt::base::core::serialization::SerializableSenderIfc
virtual void	write (uint16_t const protocolIdentifier, ::imt::base::core::serialization::SerializableIfc const *const pEventData, size_t const eventDataSizeBytes)=0
	Write object.

virtual	~SerializableSenderIfc ()=default

Protected Member Functions
ChannelIfc *	getChannel ()
	Get the modifiable pointer to the channel.

Protected Member Functions inherited from imt::base::core::serialization::SerializableSenderIfc
	SerializableSenderIfc () noexcept=default

	SerializableSenderIfc (SerializableSenderIfc const &) noexcept=delete

	SerializableSenderIfc (SerializableSenderIfc &&) noexcept=delete

SerializableSenderIfc &	operator= (SerializableSenderIfc const &) &noexcept=delete

SerializableSenderIfc &	operator= (SerializableSenderIfc &&) &noexcept=delete

Detailed Description

Messages can be sent on the output port.

An ActivePart can have 0 to N output ports.

Definition at line 53 of file PortOutput.h.

Constructor & Destructor Documentation

◆ PortOutput()

imt::base::dff::activeparts::PortOutput::PortOutput ( )

default

Constructor.

Member Function Documentation

◆ getChannel() [1/2]

ChannelIfc * imt::base::dff::activeparts::PortOutput::getChannel ( )

protected

Get the modifiable pointer to the channel.

Returns: Pointer to the channel

◆ getChannel() [2/2]

ChannelIfc const * imt::base::dff::activeparts::PortOutput::getChannel ( ) const

Get the read only pointer to the channel.

Returns: Pointer to the channel

◆ setChannel()

virtual void imt::base::dff::activeparts::PortOutput::setChannel ( ChannelIfc & channel )

virtual

Set the channel to transport the message.

Parameters

channel Channel to be set

Reimplemented in imt::base::dff::activeparts::PortOutputJoin< NumberOfPortsToJoin >.

◆ write()

void imt::base::dff::activeparts::PortOutput::write	(	uint16_t const	protocolIdentifier,
		::imt::base::core::serialization::SerializableIfc const *const	pEventData,
		size_t const	eventDataSizeBytes
	)

finalvirtual

Write data to port (is sent via the ChannelIfc)

Parameters

protocolIdentifier	identifier of protocol, is required for the receiver
pEventData	pointer to serializable event data, can also be nullptr
eventDataSizeBytes	Maximum size of the serialized event data in bytes. Used to determine whether to use a small or normal event for sending.

Implements imt::base::core::serialization::SerializableSenderIfc.

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

C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/PortOutput.h

Public Member Functions

Protected Member Functions