X-Plane Remote Access Plugin and Client Library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
xplra::SetScalarDataRefTask< T, ConcreteClass > Class Template Reference

#include <SetDataRefTask.h>

Inheritance diagram for xplra::SetScalarDataRefTask< T, ConcreteClass >:
xplra::SetDataRefTask xplra::DataRefTask xplra::Task

Public Member Functions

 SetScalarDataRefTask (const std::string &name)
 
 SetScalarDataRefTask (XPLMDataRef dataRef)
 
- Public Member Functions inherited from xplra::SetDataRefTask
 SetDataRefTask (const std::string &name)
 
 SetDataRefTask (XPLMDataRef dataRef)
 
virtual void readValue (hu::varadiistvan::scpl::io::DataStream &stream)=0
 
- Public Member Functions inherited from xplra::DataRefTask
bool isValid () const
 
const std::string & getName () const
 
XPLMDataRef getDataRef () const
 
- Public Member Functions inherited from xplra::Task
virtual ~Task ()
 

Protected Member Functions

virtual void process ()
 
- Protected Member Functions inherited from xplra::DataRefTask
 DataRefTask (const std::string &name)
 
 DataRefTask (XPLMDataRef dataRef)
 
virtual void perform ()
 

Protected Attributes

value
 

Additional Inherited Members

- Static Public Member Functions inherited from xplra::SetDataRefTask
static SetDataRefTaskcreate (uint8_t &result, hu::varadiistvan::scpl::io::DataStream &stream)
 

Detailed Description

template<typename T, class ConcreteClass>
class xplra::SetScalarDataRefTask< T, ConcreteClass >

Base class for dataref setting tasks that set a single scalar value.

ConcreteClass is the actual child class. It should have a function name setData() which performs the actual setting.

Definition at line 97 of file SetDataRefTask.h.

Constructor & Destructor Documentation

◆ SetScalarDataRefTask() [1/2]

template<typename T , class ConcreteClass >
xplra::SetScalarDataRefTask< T, ConcreteClass >::SetScalarDataRefTask ( const std::string &  name)
inline

Construct the task for setting the data referenced by the dataref with the given name.

Definition at line 367 of file SetDataRefTask.h.

◆ SetScalarDataRefTask() [2/2]

template<typename T , class ConcreteClass >
xplra::SetScalarDataRefTask< T, ConcreteClass >::SetScalarDataRefTask ( XPLMDataRef  dataRef)
inline

Construct the task for setting the data referenced by the given dataref.

Definition at line 376 of file SetDataRefTask.h.

Member Function Documentation

◆ process()

template<typename T , class ConcreteClass >
void xplra::SetScalarDataRefTask< T, ConcreteClass >::process
protectedvirtual

Perform the actual operation.

Implements xplra::DataRefTask.

Definition at line 385 of file SetDataRefTask.h.

Member Data Documentation

◆ value

template<typename T , class ConcreteClass >
T xplra::SetScalarDataRefTask< T, ConcreteClass >::value
protected

The value to set.

Definition at line 103 of file SetDataRefTask.h.


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