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 161 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	bindChannelForPODTypePacket (ChannelObject *channel)

dwStatus	bindChannelWithReference (ChannelObject *channel, GenericDataReference &ref)

detail::vectorIterable< T >	getAllBufferIter ()

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)

	SyncPortHelper ()

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

virtual ChannelObject *	getChannel ()

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

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 166 of file Port.hpp.

◆ BaseSyncHelper

template<typename T >

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

Definition at line 168 of file Port.hpp.

◆ SpecimenT

template<typename T >

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

Definition at line 167 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 183 of file Port.hpp.

◆ PortOutput() [2/3]

template<typename T >

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

inlineexplicit

Definition at line 191 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 200 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 214 of file Port.hpp.

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

◆ bindChannelForPODTypePacket()

template<typename T >

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

inline

Bind channel to transfer packets of POD type, Pointers are considered POD so only shallow copy happens. It is expected to work for local share memory channel only.

Definition at line 254 of file Port.hpp.

References dw::framework::DWFRAMEWORK_METADATA_PACKET_TYPE_ID_OFFSET, dw::framework::DWFRAMEWORK_PACKET_ID_DEFAULT, dw::framework::ChannelObject::getParams(), dw::framework::ChannelObject::getProducer(), dw::framework::ChannelParams::getType(), dw::framework::ExceptionGuard::guard(), dw::framework::PortOutput< T >::isBound(), dw::framework::GenericDataReference::packetTypeID, dw::framework::SyncPortHelperOutput< T >::parseDataSynced(), and dw::framework::SHMEM_LOCAL.

◆ bindChannelWithReference()

template<typename T >

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

inline

Definition at line 220 of file Port.hpp.

References dw::framework::SyncPortHelper::getNewPacketID(), dw::framework::ChannelObject::getParams(), dw::framework::ChannelObject::getProducer(), dw::framework::ExceptionGuard::guard(), 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().

◆ getAllBufferIter()

template<typename T >

detail::vectorIterable< T > dw::framework::PortOutput< T >::getAllBufferIter ( )

inline

iterable for all the buffers in the output channel pool.

Definition at line 392 of file Port.hpp.

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

◆ getFreeElement()

template<typename T >

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

inline

Definition at line 317 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 350 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 361 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 375 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 384 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 300 of file Port.hpp.

Referenced by dw::framework::PortOutput< T >::bindChannelForPODTypePacket(), 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 398 of file Port.hpp.

References dw::framework::SyncPortHelper::isDataSynced(), dw::framework::ChannelMetadata::iterationCount, dw::framework::METADATA_ITERATION_COUNT, dw::framework::ChannelMetadata::producerId, dw::framework::setSequenceNumber(), 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 337 of file Port.hpp.

References dw::framework::SyncPortHelperOutput< T >::getMetadataPacket(), 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 291 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 370 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 305 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 164 of file Port.hpp.

◆ LOG_TAG

template<typename T >

constexpr char dw::framework::PortOutput< T >::LOG_TAG {"PortOutput"}

staticconstexpr

Definition at line 173 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()

◆ bindChannelForPODTypePacket()

◆ bindChannelWithReference()

◆ getAllBufferIter()

◆ getFreeElement()

◆ getMetadata()

◆ getSyncSignaler()

◆ getSyncWaiter()

◆ getWaitFences()

◆ isBound()

◆ populateDefaultMetadata()

◆ send()

◆ setOnDataReady()

◆ setSignalFences()

◆ wait()

Member Data Documentation

◆ DIRECTION

◆ LOG_TAG