Compute Graph Framework SDK Reference  5.8
dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType > Class Template Reference

Detailed Description

template<typename OutputProcessedDataType, typename ReadProcessedDataFunc, typename InputProcessedDataType = OutputProcessedDataType>
class dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >

Definition at line 88 of file dwChannelDrainerTemplate.hpp.

Inheritance diagram for dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >:
Collaboration diagram for dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >:

Public Member Functions

 dwChannelDrainerTemplate (dwSensorDrainerParams params, std::unique_ptr< ReadProcessedDataFunc > readProcessedDataFunc, InputDataPort inputPort)
 
dwStatus readProcessedData (OutputProcessedDataType *outFrame, dwTime_t &latestTimestamp, dwTime_t timeout, bool isDroppingData=false) override
 
virtual dwStatus reset () override
 
virtual ~dwChannelDrainerTemplate ()=default
 
- Public Member Functions inherited from dw::framework::dwBaseDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, PortInput< OutputProcessedDataType > * >
virtual dwStatus drainProcessedData (OutputProcessedDataType *processedOutput, dwTime_t &timestampOutput, dwTime_t &nextTimestampOutput, dwTime_t virtualSyncTime)
 
 dwBaseDrainerTemplate (dwSensorDrainerParams params, std::unique_ptr< ReadProcessedDataFunc > readProcessedDataFunc, PortInput< OutputProcessedDataType > * dataSource)
 
virtual dwStatus getNextData (OutputProcessedDataType *outFrame, dwTime_t timeout)
 
virtual dwStatus getNextTimestamp (dwTime_t &timestamp, dwTime_t timeout)
 
virtual dwTime_t getReadTimeout () const
 
virtual void isLockstepDataAvailable (dwStatus &status, dwTime_t &readTimeout)
 
virtual bool isVirtualDataReady (dwTime_t dataTime, dwTime_t timeout)
 
virtual dwStatus readProcessedData (OutputProcessedDataType *outFrame, dwTime_t &latestTimestamp, dwTime_t timeout, bool isDroppingData=false)=0
 
virtual dwStatus reset ()
 
void setOnDataDropped (OnDataDropped onDataDropped)
 
virtual void setVirtualSyncTime (dwTime_t virtualSyncTime)
 
virtual dwStatus tryRead (OutputProcessedDataType *outFrame, dwTime_t &latestTimestamp, dwTime_t timeout, bool isDroppingData=false)
 

Static Public Attributes

static constexpr char LOG_TAG [] = "dwChannelDrainerTemplate"
 
- Static Public Attributes inherited from dw::framework::dwBaseDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, PortInput< OutputProcessedDataType > * >
static constexpr int32_t DRAIN_SENSOR_DATA_COUNT_MAX
 
static constexpr char LOG_TAG []
 

Additional Inherited Members

- Public Types inherited from dw::framework::dwBaseDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, PortInput< OutputProcessedDataType > * >
using OnDataDropped = dw::core::Function< void(dwTime_t const)>
 
- Protected Attributes inherited from dw::framework::dwBaseDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, PortInput< OutputProcessedDataType > * >
dwTime_t m_blockingTimeout
 
PortInput< OutputProcessedDataType > * m_dataSource
 
bool m_dropStaleData
 
bool m_isVirtual
 
Node::Name_t m_name
 
bool m_nextDataReady
 
dwTime_t m_nonBlockingTimeout
 
OnDataDropped m_onDataDropped
 
bool m_outputAvailable
 
std::unique_ptr< ReadProcessedDataFunc > m_readProcessedDataFunc
 
dwTime_t m_virtualSyncTime
 
bool m_waitForNewData
 
- Static Protected Attributes inherited from dw::framework::dwBaseDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, PortInput< OutputProcessedDataType > * >
static constexpr dwTime_t REPLAY_SENSOR_READ_TIMEOUT
 

Constructor & Destructor Documentation

◆ dwChannelDrainerTemplate()

template<typename OutputProcessedDataType , typename ReadProcessedDataFunc , typename InputProcessedDataType = OutputProcessedDataType>
dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >::dwChannelDrainerTemplate ( dwSensorDrainerParams  params,
std::unique_ptr< ReadProcessedDataFunc >  readProcessedDataFunc,
InputDataPort  inputPort 
)
inlineexplicit

Definition at line 95 of file dwChannelDrainerTemplate.hpp.

◆ ~dwChannelDrainerTemplate()

template<typename OutputProcessedDataType , typename ReadProcessedDataFunc , typename InputProcessedDataType = OutputProcessedDataType>
virtual dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >::~dwChannelDrainerTemplate ( )
virtualdefault

Member Function Documentation

◆ readProcessedData()

template<typename OutputProcessedDataType , typename ReadProcessedDataFunc , typename InputProcessedDataType = OutputProcessedDataType>
dwStatus dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >::readProcessedData ( OutputProcessedDataType *  outFrame,
dwTime_t &  latestTimestamp,
dwTime_t  timeout,
bool  isDroppingData = false 
)
inlineoverridevirtual

◆ reset()

template<typename OutputProcessedDataType , typename ReadProcessedDataFunc , typename InputProcessedDataType = OutputProcessedDataType>
virtual dwStatus dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >::reset ( )
inlineoverridevirtual

Member Data Documentation

◆ LOG_TAG

template<typename OutputProcessedDataType , typename ReadProcessedDataFunc , typename InputProcessedDataType >
constexpr char dw::framework::dwChannelDrainerTemplate< OutputProcessedDataType, ReadProcessedDataFunc, InputProcessedDataType >::LOG_TAG = "dwChannelDrainerTemplate"
staticconstexpr

Definition at line 93 of file dwChannelDrainerTemplate.hpp.


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