Compute Graph Framework SDK Reference
5.4.5418 Release
For Test and Development only

Public Member Functions | Data Fields | Static Public Attributes
dw::framework::PassImpl< PassFunctionT > Class Template Reference

Detailed Description

template<typename PassFunctionT>
class dw::framework::PassImpl< PassFunctionT >

PassImpl contains the function to invoke on run().

Definition at line 121 of file Pass.hpp.

Inheritance diagram for dw::framework::PassImpl< PassFunctionT >:
dw::framework::Pass

Public Member Functions

Node * getNode () const final
 
dw::core::FixedString< MAX_NAME_LEN > const & getRunnableId (bool isSubmitPass) const final
 
 PassImpl (Node *node, PassFunctionT const passFunc, dwProcessorType const processor, dwProcessType const processType, dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime)
 Constructor with a function running on a CPU. More...
 
 PassImpl (Node *node, PassFunctionT const passFunc, dwProcessorType const processor, dwProcessType const processType, dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime, cudaStream_t const cudaStream)
 Constructor with a function running on a GPU. More...
 
 PassImpl (Node *node, PassFunctionT const passFunc, dwProcessorType const processor, dwProcessType const processType, dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime, NvMediaDla *const dlaEngine)
 Constructor with a function running on a DLA. More...
 
dwStatus run () final
 
void setRunnableId (dw::core::StringView const &runnableId) final
 

Data Fields

dwTime_t m_avgTime
 
cudaStream_t m_cudaStream
 The cuda stream to use in case the processor type is GPU. More...
 
NvMediaDla * m_dlaEngine
 The dla engine to run on in case the processor type is GPU. More...
 
dwTime_t m_maxTime
 
dwTime_t m_minTime
 
dwProcessorType m_processor
 The processor type this pass runs on. More...
 
dwProcessType m_processType
 The process type this pass runs with. More...
 

Static Public Attributes

static constexpr size_t MAX_NAME_LEN {256U}
 The maximum length of the runnable id. More...
 

Constructor & Destructor Documentation

◆ PassImpl() [1/3]

template<typename PassFunctionT >
dw::framework::PassImpl< PassFunctionT >::PassImpl ( Node *  node,
PassFunctionT const  passFunc,
dwProcessorType const  processor,
dwProcessType const  processType,
dwTime_t const  minTime,
dwTime_t const  avgTime,
dwTime_t const  maxTime 
)
inline

Constructor with a function running on a CPU.

Definition at line 126 of file Pass.hpp.

◆ PassImpl() [2/3]

template<typename PassFunctionT >
dw::framework::PassImpl< PassFunctionT >::PassImpl ( Node *  node,
PassFunctionT const  passFunc,
dwProcessorType const  processor,
dwProcessType const  processType,
dwTime_t const  minTime,
dwTime_t const  avgTime,
dwTime_t const  maxTime,
cudaStream_t const  cudaStream 
)
inline

Constructor with a function running on a GPU.

Definition at line 139 of file Pass.hpp.

References dw::framework::Pass::m_cudaStream.

◆ PassImpl() [3/3]

template<typename PassFunctionT >
dw::framework::PassImpl< PassFunctionT >::PassImpl ( Node *  node,
PassFunctionT const  passFunc,
dwProcessorType const  processor,
dwProcessType const  processType,
dwTime_t const  minTime,
dwTime_t const  avgTime,
dwTime_t const  maxTime,
NvMediaDla *const  dlaEngine 
)
inline

Constructor with a function running on a DLA.

Definition at line 161 of file Pass.hpp.

References dw::framework::Pass::m_dlaEngine.

Member Function Documentation

◆ getNode()

template<typename PassFunctionT >
Node* dw::framework::PassImpl< PassFunctionT >::getNode ( ) const
inlinefinalvirtual
See also
Pass::getNode()

Implements dw::framework::Pass.

Definition at line 213 of file Pass.hpp.

◆ getRunnableId()

template<typename PassFunctionT >
dw::core::FixedString<MAX_NAME_LEN> const& dw::framework::PassImpl< PassFunctionT >::getRunnableId ( bool  isSubmitPass) const
inlinefinalvirtual
See also
Pass::getRunnableId()

Implements dw::framework::Pass.

Definition at line 203 of file Pass.hpp.

◆ run()

template<typename PassFunctionT >
dwStatus dw::framework::PassImpl< PassFunctionT >::run ( )
inlinefinalvirtual
See also
Pass::run()

Implements dw::framework::Pass.

Definition at line 182 of file Pass.hpp.

References dw::framework::Exception::guard().

◆ setRunnableId()

template<typename PassFunctionT >
void dw::framework::PassImpl< PassFunctionT >::setRunnableId ( dw::core::StringView const &  runnableId)
inlinefinalvirtual
See also
Pass::setRunnableId()

Implements dw::framework::Pass.

Definition at line 191 of file Pass.hpp.

Field Documentation

◆ m_avgTime

dwTime_t dw::framework::Pass::m_avgTime
inherited
Deprecated:

Definition at line 91 of file Pass.hpp.

◆ m_cudaStream

cudaStream_t dw::framework::Pass::m_cudaStream
inherited

The cuda stream to use in case the processor type is GPU.

Definition at line 98 of file Pass.hpp.

Referenced by dw::framework::PassImpl< PassFunctionT >::PassImpl().

◆ m_dlaEngine

NvMediaDla* dw::framework::Pass::m_dlaEngine
inherited

The dla engine to run on in case the processor type is GPU.

Definition at line 101 of file Pass.hpp.

Referenced by dw::framework::PassImpl< PassFunctionT >::PassImpl().

◆ m_maxTime

dwTime_t dw::framework::Pass::m_maxTime
inherited
Deprecated:

Definition at line 94 of file Pass.hpp.

◆ m_minTime

dwTime_t dw::framework::Pass::m_minTime
inherited
Deprecated:

Definition at line 88 of file Pass.hpp.

◆ m_processor

dwProcessorType dw::framework::Pass::m_processor
inherited

The processor type this pass runs on.

Definition at line 81 of file Pass.hpp.

◆ m_processType

dwProcessType dw::framework::Pass::m_processType
inherited

The process type this pass runs with.

Definition at line 84 of file Pass.hpp.

◆ MAX_NAME_LEN

constexpr size_t dw::framework::Pass::MAX_NAME_LEN {256U}
staticinherited

The maximum length of the runnable id.

Definition at line 55 of file Pass.hpp.

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