Compute Graph Framework SDK Reference  5.8
dw::framework::ContextParameterProvider Class Reference

Detailed Description

A parameter provider for the dwContextHandle_t.

Definition at line 43 of file ContextParameterProvider.hpp.

Inheritance diagram for dw::framework::ContextParameterProvider:
Collaboration diagram for dw::framework::ContextParameterProvider:

Public Member Functions

 ContextParameterProvider (dwContextHandle_t const ctx) noexcept
 Constructor. More...
 
void registerAt (TypeBasedParameterProvider &provider) const override
 
 ~ContextParameterProvider () override=default
 Destructor. More...
 
- Public Member Functions inherited from dw::framework::ITypeBasedParameterProviderChild
 ITypeBasedParameterProviderChild ()=default
 Default constructor. More...
 
virtual void registerAt (TypeBasedParameterProvider &provider) const =0
 Register handlers implemented in this parameter provider at the passed type base parameter provider. More...
 
virtual ~ITypeBasedParameterProviderChild ()=default
 Destructor. More...
 

Protected Member Functions

 ContextParameterProvider (ContextParameterProvider &&)=default
 Move constructor. More...
 
 ContextParameterProvider (ContextParameterProvider const &)=default
 Copy constructor. More...
 
bool getContextHandle (void *const out) const noexcept
 Handler function to retrieve a dwContextHandle_t. More...
 
ContextParameterProvideroperator= (ContextParameterProvider &&) &=default
 Move assignment operator. More...
 
ContextParameterProvideroperator= (ContextParameterProvider const &) &=default
 Copy assignment operator. More...
 
- Protected Member Functions inherited from dw::framework::ITypeBasedParameterProviderChild
 ITypeBasedParameterProviderChild (ITypeBasedParameterProviderChild &&)=default
 Move constructor. More...
 
 ITypeBasedParameterProviderChild (ITypeBasedParameterProviderChild const &)=default
 Copy constructor. More...
 
ITypeBasedParameterProviderChildoperator= (ITypeBasedParameterProviderChild &&) &=default
 Move assignment operator. More...
 
ITypeBasedParameterProviderChildoperator= (ITypeBasedParameterProviderChild const &) &=default
 Copy assignment operator. More...
 

Constructor & Destructor Documentation

◆ ContextParameterProvider() [1/3]

dw::framework::ContextParameterProvider::ContextParameterProvider ( ContextParameterProvider const &  )
protecteddefault

Copy constructor.

◆ ContextParameterProvider() [2/3]

dw::framework::ContextParameterProvider::ContextParameterProvider ( ContextParameterProvider &&  )
protecteddefault

Move constructor.

◆ ContextParameterProvider() [3/3]

dw::framework::ContextParameterProvider::ContextParameterProvider ( dwContextHandle_t const  ctx)
noexcept

Constructor.

◆ ~ContextParameterProvider()

dw::framework::ContextParameterProvider::~ContextParameterProvider ( )
overridedefault

Destructor.

Member Function Documentation

◆ getContextHandle()

bool dw::framework::ContextParameterProvider::getContextHandle ( void *const  out) const
protectednoexcept

Handler function to retrieve a dwContextHandle_t.

◆ operator=() [1/2]

ContextParameterProvider & dw::framework::ContextParameterProvider::operator= ( ContextParameterProvider &&  ) &
protecteddefault

Move assignment operator.

◆ operator=() [2/2]

ContextParameterProvider & dw::framework::ContextParameterProvider::operator= ( ContextParameterProvider const &  ) &
protecteddefault

Copy assignment operator.

◆ registerAt()

void dw::framework::ContextParameterProvider::registerAt ( TypeBasedParameterProvider provider) const
overridevirtual

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