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

Public Member Functions | Data Fields | Static Public Attributes | Protected Member Functions
dw::framework::Pass Class Referenceabstract

Detailed Description

Pass is a runnable describes the metadata of a pass.

Definition at line 49 of file Pass.hpp.

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

Public Member Functions

virtual Node * getNode () const =0
 Get the node this pass belongs to. More...
 
virtual dw::core::FixedString< MAX_NAME_LEN > const & getRunnableId (bool isSubmitPass) const =0
 Get the runnable id. More...
 
Pass & operator= (Pass const &)=delete
 Copy assignment operator. More...
 
Pass & operator= (Pass &&)=delete
 Move assignment operator. More...
 
 Pass (Pass const &)=delete
 Copy constructor. More...
 
 Pass (Pass &&)=delete
 Move 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...
 

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...
 

Protected Member Functions

 Pass (dwProcessorType const processor, dwProcessType const processType, dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime) noexcept
 Constructor. More...
 

Constructor & Destructor Documentation

◆ ~Pass()

virtual dw::framework::Pass::~Pass ( )
virtualdefault

Destructor.

◆ Pass() [1/3]

dw::framework::Pass::Pass ( Pass const &  )
delete

Copy constructor.

◆ Pass() [2/3]

dw::framework::Pass::Pass ( Pass &&  )
delete

Move constructor.

◆ Pass() [3/3]

dw::framework::Pass::Pass ( dwProcessorType const  processor,
dwProcessType const  processType,
dwTime_t const  minTime,
dwTime_t const  avgTime,
dwTime_t const  maxTime 
)
inlineprotectednoexcept

Constructor.

Definition at line 105 of file Pass.hpp.

Member Function Documentation

◆ getNode()

virtual Node* dw::framework::Pass::getNode ( ) const
pure virtual

Get the node this pass belongs to.

Implemented in dw::framework::PassImpl< PassFunctionT >.

◆ getRunnableId()

virtual dw::core::FixedString<MAX_NAME_LEN> const& dw::framework::Pass::getRunnableId ( bool  isSubmitPass) const
pure virtual

Get the runnable id.

Implemented in dw::framework::PassImpl< PassFunctionT >.

◆ operator=() [1/2]

Pass& dw::framework::Pass::operator= ( Pass const &  )
delete

Copy assignment operator.

◆ operator=() [2/2]

Pass& dw::framework::Pass::operator= ( Pass &&  )
delete

Move assignment operator.

◆ run()

virtual dwStatus dw::framework::Pass::run ( )
pure virtual

Run the pass.

Implemented in dw::framework::PassImpl< PassFunctionT >.

◆ setRunnableId()

virtual void dw::framework::Pass::setRunnableId ( dw::core::StringView const &  runnableId)
pure virtual

Set the runnable id.

Implemented in dw::framework::PassImpl< PassFunctionT >.

Field Documentation

◆ m_avgTime

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

Definition at line 91 of file Pass.hpp.

◆ m_cudaStream

cudaStream_t dw::framework::Pass::m_cudaStream

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

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
Deprecated:

Definition at line 94 of file Pass.hpp.

◆ m_minTime

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

Definition at line 88 of file Pass.hpp.

◆ m_processor

dwProcessorType dw::framework::Pass::m_processor

The processor type this pass runs on.

Definition at line 81 of file Pass.hpp.

◆ m_processType

dwProcessType dw::framework::Pass::m_processType

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}
static

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: