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

#include <SetMultiDataRefRequest.h>

Inheritance diagram for xplra::SetMultiDataRefRequest:
xplra::MultiTaskRequestTemplate< SetDataRefTask > xplra::MultiTaskRequest xplra::Request

Public Member Functions

 SetMultiDataRefRequest (uint8_t &result, hu::varadiistvan::scpl::io::DataStream &stream, bool readValues)
 
void readValues (hu::varadiistvan::scpl::io::DataStream &stream)
 
void writeResult (hu::varadiistvan::scpl::io::DataStream &stream) const
 
- Public Member Functions inherited from xplra::MultiTaskRequestTemplate< SetDataRefTask >
void addTask (SetDataRefTask *task)
 
SetDataRefTaskgetTask (size_t index) const
 
- Public Member Functions inherited from xplra::MultiTaskRequest
virtual ~MultiTaskRequest ()
 
void addTask (Task *task)
 
size_t getNumTasks () const
 
TaskgetTask (size_t index) const
 
- Public Member Functions inherited from xplra::Request
 Request ()
 
virtual ~Request ()
 

Additional Inherited Members

- Protected Member Functions inherited from xplra::MultiTaskRequest
virtual void execute ()
 

Detailed Description

A request containing several dataref update tasks.

Definition at line 45 of file SetMultiDataRefRequest.h.

Constructor & Destructor Documentation

◆ SetMultiDataRefRequest()

SetMultiDataRefRequest::SetMultiDataRefRequest ( uint8_t &  result,
hu::varadiistvan::scpl::io::DataStream &  stream,
bool  readValues 
)

Construct the request by reading the task specifications from the given stream.

Definition at line 43 of file SetMultiDataRefRequest.cc.

Member Function Documentation

◆ readValues()

void SetMultiDataRefRequest::readValues ( hu::varadiistvan::scpl::io::DataStream &  stream)

Read the values of all tasks.

Definition at line 70 of file SetMultiDataRefRequest.cc.

◆ writeResult()

void SetMultiDataRefRequest::writeResult ( hu::varadiistvan::scpl::io::DataStream &  stream) const

Write the result of an execution.

If there is at least one invalid dataref, the result will be RESULT_UNKNOWN_DATAREF followed by a 32-bit unsigned value with the index of the first unknown dataref.

Otherwise the result is RESULT_OK.

Definition at line 81 of file SetMultiDataRefRequest.cc.


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