Compute Graph Framework SDK Reference  5.16
List of all members | Public Types | Public Member Functions
dw::framework::RegisteredPortInput< T > Class Template Reference

Detailed Description

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

A specialization of PortInput that contains the port id.

Definition at line 60 of file RegisteredPort.hpp.

Inheritance diagram for dw::framework::RegisteredPortInput< T >:
Inheritance graph
[legend]
Collaboration diagram for dw::framework::RegisteredPortInput< T >:
Collaboration graph
[legend]

Public Types

using Base = PortInput< T >
 
- Public Types inherited from dw::framework::PortInput< T >
using ApiDataTypeT = T
 
using BaseSyncHelper = SyncPortHelperInput< T >
 
using SpecimenT = typename parameter_traits< T >::SpecimenT
 

Public Member Functions

template<typename... Args>
 RegisteredPortInput (size_t portID, Args &&... args)
 
- Public Member Functions inherited from dw::framework::PortInput< T >
dwStatus bindChannel (ChannelObject *channel) override
 
detail::vectorIterable< T > getAllBufferIter ()
 
ChannelMetadata & getMetadata (T *frame)
 
ChannelObject::SyncSignaler & getSyncSignaler ()
 
ChannelObject::SyncWaiter & getSyncWaiter ()
 
void getWaitFences (T *frame, dw::core::span< NvSciSyncFence > fences)
 
bool isBound () override
 
 PortInput ()
 
 PortInput (OnSetSyncAttrs waiterAttrs, OnSetSyncAttrs signalerAttrs={})
 
 PortInput (SpecimenT &&ref)
 
 PortInput (SpecimenT const &ref)
 
 PortInput (SpecimenT const &ref, OnSetSyncAttrs waiterAttrs, OnSetSyncAttrs signalerAttrs={})
 
virtual std::shared_ptr< T > recv ()
 
void setOnDataReady (void *opaque, ChannelObject::PacketPool::OnDataReady onDataReady)
 
void setSignalFences (T *frame, dw::core::span< NvSciSyncFence > fences)
 
dwStatus wait (dwTime_t timeout)
 
 ~PortInput () override=default
 
- Public Member Functions inherited from dw::framework::SyncPortHelperInput< T >
 SyncPortHelperInput ()
 
- 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
 
- Public Member Functions inherited from dw::framework::RegisteredPort
size_t getPortID () const
 
 RegisteredPort (size_t portID)
 

Additional Inherited Members

- Static Public Attributes inherited from dw::framework::PortInput< T >
static constexpr PortDirection DIRECTION = PortDirection::INPUT
 
- Protected Member Functions inherited from dw::framework::SyncPortHelperInput< T >
T * extractInternalPacket (GenericData genericData)
 
T * extractSyncPacket (GenericData genericData)
 
GenericData getBufferedPacket ()
 
MetadataPayload * getMetadataPacket (T *frame)
 
bool isPacketBuffered ()
 
bool isValidPacketBuffered ()
 
void parseDataSynced (const ChannelParams &params) override
 
- Protected Member Functions inherited from dw::framework::SyncPortHelper
ChannelPacketTypeID getNewPacketID (ChannelPacketTypeID packetTypeID)
 
void stampSyncCount (uint32_t &syncCountOut) const
 
- 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}
 
- Protected Attributes inherited from dw::framework::RegisteredPort
size_t m_portID
 

Member Typedef Documentation

◆ Base

template<typename T >
using dw::framework::RegisteredPortInput< T >::Base = PortInput<T>

Definition at line 63 of file RegisteredPort.hpp.

Constructor & Destructor Documentation

◆ RegisteredPortInput()

template<typename T >
template<typename... Args>
dw::framework::RegisteredPortInput< T >::RegisteredPortInput ( size_t  portID,
Args &&...  args 
)
inlineexplicit

Definition at line 66 of file RegisteredPort.hpp.

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