Detailed Description

template<typename T>
class dw::framework::PortOutput< T >

PortOutput mimics an Output Block. It wrapps over a Producer Channel. Provides services like

binding(allocating channel resources, out of current scope),
getting next free element
sending data

Definition at line 89 of file Port.hpp.

Inheritance diagram for dw::framework::PortOutput< T >:

[legend]

Collaboration diagram for dw::framework::PortOutput< T >:

[legend]

Public Types
using	ApiDataTypeT = T

using	BaseSyncHelper = SyncPortHelperOutput< T >

using	SpecimenT = typename parameter_traits< T >::SpecimenT

Public Member Functions
dwStatus	bindChannel (ChannelObject *channel) override

dwStatus	bindChannelWithReference (ChannelObject *channel, GenericDataReference &ref)

T *	getFreeElement ()

ChannelMetadata &	getMetadata (T *frame)

ChannelObject::SyncSignaler &	getSyncSignaler ()

ChannelObject::SyncWaiter &	getSyncWaiter ()

void	getWaitFences (T *frame, dw::core::span< NvSciSyncFence > fences)

bool	isBound () final

	PortOutput (SpecimenT &&ref)

	PortOutput (SpecimenT const &ref)

	PortOutput (SpecimenT const &ref, OnSetSyncAttrs signalerAttrs, OnSetSyncAttrs waiterAttrs={})

virtual dwStatus	send (T *frame)

void	setOnDataReady (void *opaque, ChannelObject::PacketPool::OnDataReady onDataReady)

void	setSignalFences (T *frame, dw::core::span< NvSciSyncFence > fences)

dwStatus	wait (dwTime_t timeout)

Public Member Functions inherited from dw::framework::SyncPortHelperOutput< T >
	SyncPortHelperOutput ()

Public Member Functions inherited from dw::framework::SyncPortHelper
bool	isDataSynced ()

virtual void	parseDataSynced (const ChannelParams &params)

void	setSyncCount (uint32_t index)

dwStatus	setSyncRetriever (const CycleCountFetcher &func)

	SyncPortHelper ()

Public Member Functions inherited from dw::framework::Port
virtual dwStatus	bindChannel (ChannelObject *channel)=0

virtual ChannelObject *	getChannel ()

virtual dwStatus	initialize ()

virtual bool	isBound ()=0

Public Member Functions inherited from dw::framework::PortBase
virtual	~PortBase ()=default

Static Public Attributes
static constexpr PortDirection	DIRECTION = PortDirection::OUTPUT

static constexpr char	LOG_TAG [] = "PortOutput"

Protected Member Functions
void	populateDefaultMetadata (ChannelMetadata &header)

Protected Member Functions inherited from dw::framework::SyncPortHelperOutput< T >
T *	extractInternalPacket (GenericData genericData)

MetadataPayload *	getMetadataPacket (T *frame)

void	parseDataSynced (const ChannelParams &params) override

Protected Member Functions inherited from dw::framework::SyncPortHelper
ChannelPacketTypeID	getNewPacketID (ChannelPacketTypeID packetTypeID)

void	stampSyncCount (uint32_t &syncCountOut) const

Additional Inherited Members
Protected Attributes inherited from dw::framework::SyncPortHelper
uint32_t	m_dataOffset

bool	m_dataSynced

uint32_t	m_syncCount

CycleCountFetcher	m_syncCountRetriever

Protected Attributes inherited from dw::framework::Port
ChannelObject *	m_channel {nullptr}

Member Typedef Documentation

◆ ApiDataTypeT

template<typename T >

using dw::framework::PortOutput< T >::ApiDataTypeT = T

Definition at line 93 of file Port.hpp.

◆ BaseSyncHelper

template<typename T >

using dw::framework::PortOutput< T >::BaseSyncHelper = SyncPortHelperOutput<T>

Definition at line 95 of file Port.hpp.

◆ SpecimenT

template<typename T >

using dw::framework::PortOutput< T >::SpecimenT = typename parameter_traits<T>::SpecimenT

Definition at line 94 of file Port.hpp.

Constructor & Destructor Documentation

◆ PortOutput() [1/3]

template<typename T >

dw::framework::PortOutput< T >::PortOutput ( SpecimenT const & ref )

inlineexplicit

Definition at line 109 of file Port.hpp.

◆ PortOutput() [2/3]

template<typename T >

dw::framework::PortOutput< T >::PortOutput ( SpecimenT && ref )

inlineexplicit

Definition at line 113 of file Port.hpp.

◆ PortOutput() [3/3]

template<typename T >

dw::framework::PortOutput< T >::PortOutput	(	SpecimenT const &	ref,
		OnSetSyncAttrs	signalerAttrs,
		OnSetSyncAttrs	waiterAttrs = `{}`
	)

inlineexplicit

Definition at line 118 of file Port.hpp.

Member Function Documentation

◆ bindChannel()

template<typename T >

dwStatus dw::framework::PortOutput< T >::bindChannel ( ChannelObject * channel )

inlineoverridevirtual

Implements dw::framework::Port.

Definition at line 128 of file Port.hpp.

References dw::framework::PortOutput< T >::bindChannelWithReference().

◆ bindChannelWithReference()

template<typename T >

dwStatus dw::framework::PortOutput< T >::bindChannelWithReference	(	ChannelObject *	channel,
		GenericDataReference &	ref
	)

inline

Definition at line 134 of file Port.hpp.

References dw::framework::SyncPortHelper::getNewPacketID(), dw::framework::ChannelObject::getParams(), dw::framework::ChannelObject::getProducer(), dw::framework::PortOutput< T >::isBound(), dw::framework::Port::m_channel, dw::framework::GenericDataReference::packetTypeID, dw::framework::SyncPortHelperOutput< T >::parseDataSynced(), dw::framework::GenericDataReference::setSignalerAttributes, and dw::framework::GenericDataReference::setWaiterAttributes.

Referenced by dw::framework::PortOutput< T >::bindChannel().

◆ getFreeElement()

template<typename T >

T * dw::framework::PortOutput< T >::getFreeElement ( )

inline

Definition at line 189 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::extractInternalPacket(), dw::framework::extractMetadata(), dw::framework::ChannelObject::Producer::get(), dw::framework::MetadataPayload::header, and dw::framework::ChannelMetadata::validFields.

◆ getMetadata()

template<typename T >

ChannelMetadata & dw::framework::PortOutput< T >::getMetadata ( T * frame )

inline

Definition at line 220 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::getMetadataPacket(), and dw::framework::MetadataPayload::header.

◆ getSyncSignaler()

template<typename T >

ChannelObject::SyncSignaler & dw::framework::PortOutput< T >::getSyncSignaler ( )

inline

Definition at line 231 of file Port.hpp.

References dw::framework::ChannelObject::PacketPool::getSyncSignaler().

◆ getSyncWaiter()

template<typename T >

ChannelObject::SyncWaiter & dw::framework::PortOutput< T >::getSyncWaiter ( )

inline

Definition at line 245 of file Port.hpp.

References dw::framework::ChannelObject::PacketPool::getSyncWaiter().

◆ getWaitFences()

template<typename T >

void dw::framework::PortOutput< T >::getWaitFences	(	T *	frame,
		dw::core::span< NvSciSyncFence >	fences
	)

inline

Definition at line 254 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::getMetadataPacket(), dw::framework::ChannelObject::PacketPool::getSyncWaiter(), and dw::framework::ChannelObject::SyncWaiter::getWaitFences().

◆ isBound()

template<typename T >

bool dw::framework::PortOutput< T >::isBound ( )

inlinefinalvirtual

Implements dw::framework::Port.

Definition at line 172 of file Port.hpp.

Referenced by dw::framework::PortOutput< T >::bindChannelWithReference(), dw::framework::PortOutput< T >::setOnDataReady(), and dw::framework::PortOutput< T >::wait().

◆ populateDefaultMetadata()

template<typename T >

void dw::framework::PortOutput< T >::populateDefaultMetadata ( ChannelMetadata & header )

inlineprotected

Definition at line 260 of file Port.hpp.

References dw::framework::SyncPortHelper::isDataSynced(), dw::framework::ChannelMetadata::iterationCount, dw::framework::METADATA_ITERATION_COUNT, dw::framework::ChannelMetadata::producerId, dw::framework::ChannelMetadata::sequenceNum, dw::framework::SyncPortHelper::stampSyncCount(), and dw::framework::ChannelMetadata::validFields.

Referenced by dw::framework::PortOutput< T >::send().

◆ send()

template<typename T >

virtual dwStatus dw::framework::PortOutput< T >::send ( T * frame )

inlinevirtual

Definition at line 208 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::getMetadataPacket(), dw::framework::MetadataPayload::header, dw::framework::PortOutput< T >::populateDefaultMetadata(), and dw::framework::ChannelObject::Producer::send().

◆ setOnDataReady()

template<typename T >

void dw::framework::PortOutput< T >::setOnDataReady	(	void *	opaque,
		ChannelObject::PacketPool::OnDataReady	onDataReady
	)

inline

Definition at line 163 of file Port.hpp.

References dw::framework::PortOutput< T >::isBound(), and dw::framework::ChannelObject::PacketPool::setOnDataReady().

◆ setSignalFences()

template<typename T >

void dw::framework::PortOutput< T >::setSignalFences	(	T *	frame,
		dw::core::span< NvSciSyncFence >	fences
	)

inline

Definition at line 240 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::getMetadataPacket(), dw::framework::ChannelObject::PacketPool::getSyncSignaler(), and dw::framework::ChannelObject::SyncSignaler::setSignalFences().

◆ wait()

template<typename T >

dwStatus dw::framework::PortOutput< T >::wait ( dwTime_t timeout )

inline

Definition at line 177 of file Port.hpp.

References dw::framework::PortOutput< T >::isBound(), and dw::framework::ChannelObject::PacketPool::wait().

Member Data Documentation

◆ DIRECTION

template<typename T >

constexpr PortDirection dw::framework::PortOutput< T >::DIRECTION = PortDirection::OUTPUT

staticconstexpr

Definition at line 92 of file Port.hpp.

◆ LOG_TAG

template<typename T >

constexpr char dw::framework::PortOutput< T >::LOG_TAG = "PortOutput"

staticconstexpr

Definition at line 99 of file Port.hpp.

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

src/dwcgf/core/dwcgf/port/Port.hpp

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ApiDataTypeT

◆ BaseSyncHelper

◆ SpecimenT

Constructor & Destructor Documentation

◆ PortOutput() [1/3]

◆ PortOutput() [2/3]

◆ PortOutput() [3/3]

Member Function Documentation

◆ bindChannel()

◆ bindChannelWithReference()

◆ getFreeElement()

◆ getMetadata()

◆ getSyncSignaler()

◆ getSyncWaiter()

◆ getWaitFences()

◆ isBound()

◆ populateDefaultMetadata()

◆ send()

◆ setOnDataReady()

◆ setSignalFences()

◆ wait()

Member Data Documentation

◆ DIRECTION

◆ LOG_TAG