Dataflow Runtime API  2.7.4.0
Public Member Functions | Protected Member Functions | List of all members
imt::base::dff::activeparts::PortOutput Class Reference

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

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

Inheritance diagram for imt::base::dff::activeparts::PortOutput:
imt::base::dff::activeparts::PortOutputJoin< NumberOfPortsToJoin >

Public Member Functions

 PortOutput (void)
 Constructor.
 
virtual ~PortOutput (void)
 Destructor.
 
void write (const uint16_t protocolIdentifier, const imt::base::core::serialization::SerializableIfc *const pEventData=NULL, const int32_t eventDataSizeBytes=imt::base::dff::runtime::EVENTDATA_SIZE_BYTES)
 Write data to port (is sent via the ChannelIfc) More...
 
virtual void setChannel (ChannelIfc &channel)
 Set the channel to transport the message. More...
 
const ChannelIfcgetChannel (void) const
 Get the read only pointer to the channel. More...
 

Protected Member Functions

ChannelIfcgetChannel (void)
 Get the modifiable pointer to the channel. More...
 

Detailed Description

Messages can be sent on the output port.

An ActivePart can have 0 to N output ports.

Member Function Documentation

◆ getChannel() [1/2]

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

Get the modifiable pointer to the channel.

Returns
Pointer to the channel

◆ getChannel() [2/2]

const ChannelIfc* imt::base::dff::activeparts::PortOutput::getChannel ( void  ) 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
channelChannel to be set

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

◆ write()

void imt::base::dff::activeparts::PortOutput::write ( const uint16_t  protocolIdentifier,
const imt::base::core::serialization::SerializableIfc *const  pEventData = NULL,
const int32_t  eventDataSizeBytes = imt::base::dff::runtime::EVENTDATA_SIZE_BYTES 
)

Write data to port (is sent via the ChannelIfc)

Parameters
protocolIdentifieridentifier of protocol, is required for the receiver
pEventDatapointer to serializable event data, can also be NULL
eventDataSizeBytesMaximum size of the serialized event data in bytes. Used to determine whether to use a small or normal event for sending.

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