This is the documentation for Enlighten.

class Enlighten WorkerFunctorCommand

template<class Functor>
class Enlighten::WorkerFunctorCommand

    └>Enlighten::Command

===============================

A command that holds a reference to its movable parameter


===============================

No Ref


/


Enqueue function pointer


/ Enqueue function pointer 0 param inline void EnqueueWorkerCommand(IUpdateManager* updateManager, FunctionPointer0::CallbackType callback) { GenericUpdateManagerCommand0 newCommand(callback); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/ Enqueue function pointer 1 param template<typename Param1Type> void EnqueueWorkerCommand(IUpdateManager* updateManager, typename FunctionPointer1<Param1Type>::CallbackType callback, Param1Type input1) { typedef GenericUpdateManagerCommand1< FunctionPointer1<Param1Type> > CommandType; CommandType newCommand(callback, input1); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/ Enqueue function pointer 2 param template<typename Param1Type, typename Param2Type> void EnqueueWorkerCommand(IUpdateManager* updateManager, typename FunctionPointer2<Param1Type, Param2Type>::CallbackType callback, Param1Type input1, Param2Type input2) { typedef GenericUpdateManagerCommand2< FunctionPointer2<Param1Type, Param2Type> > CommandType; CommandType newCommand(callback, input1, input2); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/ Enqueue function pointer 3 param template<typename Param1Type, typename Param2Type, typename Param3Type> void EnqueueWorkerCommand( IUpdateManager* updateManager, typename FunctionPointer3<Param1Type, Param2Type, Param3Type>::CallbackType callback, Param1Type input1, Param2Type input2, Param3Type input3) { typedef GenericUpdateManagerCommand3< FunctionPointer3<Param1Type, Param2Type, Param3Type> > CommandType; CommandType newCommand(callback, input1, input2, input3); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/ Enqueue function pointer 4 param template<typename Param1Type, typename Param2Type, typename Param3Type, typename Param4Type> void EnqueueWorkerCommand( IUpdateManager* updateManager, typename FunctionPointer4<Param1Type, Param2Type, Param3Type, Param4Type>::CallbackType callback, Param1Type input1, Param2Type input2, Param3Type input3, Param4Type input4) { typedef GenericUpdateManagerCommand4< FunctionPointer4<Param1Type, Param2Type, Param3Type, Param4Type> > CommandType; CommandType newCommand(callback, input1, input2, input3, input4); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/ Enqueue function pointer 5 param template<typename Param1Type, typename Param2Type, typename Param3Type, typename Param4Type, typename Param5Type> void EnqueueWorkerCommand( IUpdateManager* updateManager, typename FunctionPointer5<Param1Type, Param2Type, Param3Type, Param4Type, Param5Type>::CallbackType callback, Param1Type input1, Param2Type input2, Param3Type input3, Param4Type input4, Param5Type input5) { typedef GenericUpdateManagerCommand5< FunctionPointer5<Param1Type, Param2Type, Param3Type, Param4Type, Param5Type> > CommandType; CommandType newCommand(callback, input1, input2, input3, input4, input5); EnqueueCommand(updateManager, GeoStd::Move(newCommand)); }

/**===============================

Callable object (incl. lambda expressions) worker commands.


Functions

Name Description
Execute(IUpdateManagerWorker *)

Function called when the command is executed, which will happen on the worker thread if one is running.

Execute(IUpdateManagerWorker *)

Function called when the command is executed, which will happen on the worker thread if one is running.

WorkerFunctorCommand(Functor &&)

Constructor.

WorkerFunctorCommand(WorkerFunctorCommand &&)

Move Constructor.


virtual void Enlighten::WorkerFunctorCommand< Functor >::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.


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::WorkerFunctorCommand< Functor >::WorkerFunctorCommand


public: WorkerFunctorCommand
(
    Functor && functor
)


Constructor.


Enlighten::WorkerFunctorCommand< Functor >::WorkerFunctorCommand


public: WorkerFunctorCommand
(
    WorkerFunctorCommand && other
)


Move Constructor.