X-Plane Remote Access Plugin and Client Library
Protected Member Functions | Private Member Functions | Friends | List of all members
hu::varadiistvan::xplra::MultiGetter Class Reference

#include <MultiGetter.h>

Inheritance diagram for hu::varadiistvan::xplra::MultiGetter:
hu::varadiistvan::xplra::MultiBuffer

Protected Member Functions

virtual void doExecute ()
 
virtual void doExecuteUnregistered ()
 
- Protected Member Functions inherited from hu::varadiistvan::xplra::MultiBuffer
 MultiBuffer (XPlane &xplane, uint8_t registerCommand, uint8_t unregisterCommand) noexcept
 
virtual ~MultiBuffer () noexcept
 
void writeSpec (uint8_t command) const
 
void reregisterInXPlane ()
 

Private Member Functions

 MultiGetter (XPlane &xplane) noexcept
 
void read (const DataRef &dataRef)
 
void readValues ()
 

Friends

class XPlane
 

Additional Inherited Members

- Public Member Functions inherited from hu::varadiistvan::xplra::MultiBuffer
XPlanegetXPlane () const noexcept
 
size_t addInt (const std::string &name) noexcept
 
size_t addFloat (const std::string &name) noexcept
 
size_t addDouble (const std::string &name) noexcept
 
size_t addFloatArray (const std::string &name, size_t length, size_t offset=0) noexcept
 
size_t addIntArray (const std::string &name, size_t length, size_t offset=0) noexcept
 
size_t addByteArray (const std::string &name, size_t length, size_t offset=0) noexcept
 
bool finalize () const
 
void registerInXPlane ()
 
void unregisterFromXPlane ()
 
bool unregisterSafelyFromXPlane () noexcept
 
void execute ()
 
void setInt (size_t id, int value)
 
int getInt (size_t id) const
 
const int32_t & getIntRef (size_t id) const
 
int32_t & getIntRef (size_t id)
 
void setFloat (size_t id, float value)
 
float getFloat (size_t id) const
 
const float & getFloatRef (size_t id) const
 
float & getFloatRef (size_t id)
 
void setDouble (size_t id, double value)
 
double getDouble (size_t id) const
 
const double & getDoubleRef (size_t id) const
 
double & getDoubleRef (size_t id)
 
size_t setFloatArray (size_t id, const float *value, size_t length=0, size_t offset=0)
 
size_t getFloatArray (size_t id, float *value, size_t length=0, size_t offset=0) const
 
const float * getFloatArray (size_t id, size_t offset=0) const
 
size_t setIntArray (size_t id, const int32_t *value, size_t length=0, size_t offset=0)
 
size_t getIntArray (size_t id, int32_t *value, size_t length=0, size_t offset=0) const
 
const int32_t * getIntArray (size_t id, size_t offset=0) const
 
size_t setByteArray (size_t id, const uint8_t *value, size_t length=0, size_t offset=0)
 
size_t getByteArray (size_t id, uint8_t *value, size_t length=0, size_t offset=0) const
 
const uint8_t * getByteArray (size_t id, size_t offset=0) const
 
size_t setString (size_t id, const std::string &value, size_t offset=0)
 
std::string getString (size_t id, size_t offset=0) const
 
const char * getStringPtr (size_t id, size_t offset=0) const
 
- Protected Attributes inherited from hu::varadiistvan::xplra::MultiBuffer
std::vector< DataRefdataRefs
 
unsigned char * data
 
XPlanexplane
 
uint8_t registerCommand
 
uint8_t unregisterCommand
 
int registeredID
 

Detailed Description

A multi-dataref buffer used to query those data.

Definition at line 44 of file MultiGetter.h.

Constructor & Destructor Documentation

◆ MultiGetter()

MultiGetter::MultiGetter ( XPlane xplane)
privatenoexcept

Construct the object for the given XPlane instance.

Definition at line 52 of file MultiGetter.cc.

Member Function Documentation

◆ doExecute()

void MultiGetter::doExecute ( )
protectedvirtual
See also
MultiBuffer::doExecute

Implements hu::varadiistvan::xplra::MultiBuffer.

Definition at line 93 of file MultiGetter.cc.

◆ doExecuteUnregistered()

void MultiGetter::doExecuteUnregistered ( )
protectedvirtual

◆ read()

void MultiGetter::read ( const DataRef dataRef)
inlineprivate

Read the value of the given dataref from the stream into the buffer.

Definition at line 60 of file MultiGetter.cc.

◆ readValues()

void MultiGetter::readValues ( )
private

Read all the values.

Definition at line 116 of file MultiGetter.cc.


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