X-Plane Remote Access Plugin and Client Library
Public Member Functions | Static Public Member Functions | List of all members
xplra::GetIntDataRefTask Class Reference

#include <GetDataRefTask.h>

Inheritance diagram for xplra::GetIntDataRefTask:
xplra::GetScalarDataRefTask< int, GetIntDataRefTask > xplra::GetDataRefTask xplra::DataRefTask xplra::Task

Public Member Functions

 GetIntDataRefTask (const std::string &name)
 
 GetIntDataRefTask (XPLMDataRef dataRef)
 
virtual void writeValue (hu::varadiistvan::scpl::io::DataStream &stream)
 
- Public Member Functions inherited from xplra::GetScalarDataRefTask< int, GetIntDataRefTask >
 GetScalarDataRefTask (const std::string &name)
 
 GetScalarDataRefTask (XPLMDataRef dataRef)
 
int getValue () const
 
- Public Member Functions inherited from xplra::GetDataRefTask
 GetDataRefTask (const std::string &name)
 
 GetDataRefTask (XPLMDataRef dataRef)
 
- 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 ()
 

Static Public Member Functions

static int queryData (XPLMDataRef dataRef)
 
- Static Public Member Functions inherited from xplra::GetDataRefTask
static GetDataRefTaskcreate (uint8_t &result, hu::varadiistvan::scpl::io::DataStream &stream)
 

Additional Inherited Members

- Protected Member Functions inherited from xplra::GetScalarDataRefTask< int, GetIntDataRefTask >
virtual void process ()
 
- Protected Member Functions inherited from xplra::DataRefTask
 DataRefTask (const std::string &name)
 
 DataRefTask (XPLMDataRef dataRef)
 
virtual void perform ()
 

Detailed Description

A dataref task which retrieves the value of an integer.

Definition at line 122 of file GetDataRefTask.h.

Constructor & Destructor Documentation

◆ GetIntDataRefTask() [1/2]

xplra::GetIntDataRefTask::GetIntDataRefTask ( const std::string &  name)
inline

Construct the task for the dataref with the given name.

Definition at line 586 of file GetDataRefTask.h.

◆ GetIntDataRefTask() [2/2]

xplra::GetIntDataRefTask::GetIntDataRefTask ( XPLMDataRef  dataRef)
inline

Construct the task for the given dataref.

Definition at line 593 of file GetDataRefTask.h.

Member Function Documentation

◆ queryData()

int xplra::GetIntDataRefTask::queryData ( XPLMDataRef  dataRef)
inlinestatic

Query the value from XPLM

Definition at line 579 of file GetDataRefTask.h.

◆ writeValue()

void GetIntDataRefTask::writeValue ( hu::varadiistvan::scpl::io::DataStream &  stream)
virtual

Write the value into the given stream.

Implements xplra::GetDataRefTask.

Definition at line 100 of file GetDataRefTask.cc.


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