Compute Graph Framework SDK Reference  5.12
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 104 of file Pass.hpp.

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

Public Member Functions

NodegetNode () const final
 
dw::core::FixedString< MAX_NAME_LEN > const & getRunnableId (bool isSubmitPass) const final
 
 PassImpl (Node &node, PassFunctionT const passFunc, dwProcessorType const processor, cudaStream_t const cudaStream, std::initializer_list< std::pair< dwStatus, uint32_t > > const &returnMapping={})
 
 PassImpl (Node &node, PassFunctionT const passFunc, dwProcessorType const processor, std::initializer_list< std::pair< dwStatus, uint32_t > > const &returnMapping={})
 Constructor with a function running on the given processor type. More...
 
dwStatus run () final
 
void setRunnableId (dw::core::StringView const &runnableId) final
 
- Public Member Functions inherited from dw::framework::Pass
virtual NodegetNode () const =0
 Get the node this pass belongs to. More...
 
dw::core::HeapHashMap< dwStatus, uint32_t > const & getPassReturnErrorMap ()
 Get the return status code to error map. More...
 
virtual dw::core::FixedString< MAX_NAME_LEN > const & getRunnableId (bool isSubmitPass) const =0
 Get the runnable id. More...
 
Passoperator= (Pass &&) &=delete
 Move assignment operator. More...
 
Passoperator= (Pass const &) &=delete
 Copy assignment operator. More...
 
 Pass (Pass &&)=delete
 Move constructor. More...
 
 Pass (Pass const &)=delete
 Copy constructor. More...
 
virtual dwStatus run ()=0
 Run the pass. More...
 
virtual void setRunnableId (dw::core::StringView const &runnableId)=0
 Set the runnable id. More...
 
virtual ~Pass ()=default
 Destructor. More...
 

Additional Inherited Members

- Public Attributes inherited from dw::framework::Pass
cudaStream_t m_cudaStream
 The cuda stream to use in case the processor type is GPU. More...
 
bool m_isFirstIteration
 
dwProcessorType m_processor
 The processor type this pass runs on. More...
 
- Static Public Attributes inherited from dw::framework::Pass
static constexpr const size_t MAX_NAME_LEN {256U}
 The maximum length of the runnable id. More...
 
- Protected Member Functions inherited from dw::framework::Pass
 Pass (dwProcessorType const processor, std::initializer_list< std::pair< dwStatus, uint32_t > > const &returnMapping={})
 Constructor. More...
 

Constructor & Destructor Documentation

◆ PassImpl() [1/2]

template<typename PassFunctionT >
dw::framework::PassImpl< PassFunctionT >::PassImpl ( Node node,
PassFunctionT const  passFunc,
dwProcessorType const  processor,
std::initializer_list< std::pair< dwStatus, uint32_t > > const &  returnMapping = {} 
)
inline

Constructor with a function running on the given processor type.

Definition at line 110 of file Pass.hpp.

◆ PassImpl() [2/2]

template<typename PassFunctionT >
dw::framework::PassImpl< PassFunctionT >::PassImpl ( Node node,
PassFunctionT const  passFunc,
dwProcessorType const  processor,
cudaStream_t const  cudaStream,
std::initializer_list< std::pair< dwStatus, uint32_t > > const &  returnMapping = {} 
)
inline

Constructor with a function running on a GPU.

Deprecated:

Definition at line 122 of file Pass.hpp.

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 176 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 166 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 142 of file Pass.hpp.

References dw::framework::ExceptionGuard::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 152 of file Pass.hpp.


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