This is the documentation for Enlighten.
class Enlighten WorkerFunctionParameterCommand
- William Joseph
- geosw (Unlicensed)
template<typename ParameterType>
class Enlighten::WorkerFunctionParameterCommand
Command to execute a function in the IUpdateManagerWorker interface with one input argument.
For readability, rather than many template variants for different function types, instead the worker functions use small structures to pass arguments in a block. See IUpdateManagerWorker.h for details.
Variables
| Name | Description |
|---|---|
| void(IUpdateManagerWorker::* m_Function)(ParameterType const &) | Function pointer to worker function to call. |
| ParameterType m_Parameter | Parameter to pass. |
Functions
| Name | Description |
|---|---|
| Execute(IUpdateManagerWorker *) | Function which actually executes the command, calling the function and passing the parameter. |
| Execute(IUpdateManagerWorker *) | Function called when the command is executed, which will happen on the worker thread if one is running. |
| WorkerFunctionParameterCommand(void(IUpdateManagerWorker::*)(ParameterType const &), ParameterType const &) | Constructor, taking a function pointer and a parameter. |
virtual void Enlighten::WorkerFunctionParameterCommand< ParameterType >::Execute
public: virtual void Execute
(
IUpdateManagerWorker * worker
)
Function which actually executes the command, calling the function and passing the parameter.
virtual void Enlighten::Command::Execute
public: virtual void Execute
(
IUpdateManagerWorker * worker
)
Function called when the command is executed, which will happen on the worker thread if one is running.
Enlighten::WorkerFunctionParameterCommand< ParameterType >::WorkerFunctionParameterCommand
public: WorkerFunctionParameterCommand
(
void(IUpdateManagerWorker::*)(ParameterType const &) function,
ParameterType const & parameter
)
Constructor, taking a function pointer and a parameter.