SetDataRefTask.h

// Copyright (c) 2013 by István Váradi
 
// This file is part of XPLRA, a remote-access plugin for X-Plane
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
#ifndef XPLRA_SETDATAREFTASK_H
#define XPLRA_SETDATAREFTASK_H
//------------------------------------------------------------------------------
 
#include "DataRefTask.h"
 
#include <hu/varadiistvan/scpl/io/DataStream.h>
 
//------------------------------------------------------------------------------
 
namespace xplra {
 
//------------------------------------------------------------------------------
 
class SetDataRefTask : public DataRefTask
{
public:
    static SetDataRefTask* create(uint8_t& result, hu::varadiistvan::scpl::io::DataStream& stream);
 
    SetDataRefTask(const std::string& name);
 
    SetDataRefTask(XPLMDataRef dataRef);
 
    virtual void readValue(hu::varadiistvan::scpl::io::DataStream& stream) = 0;
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
class SetScalarDataRefTask : public SetDataRefTask
{
protected:
    T value;
 
public:
    SetScalarDataRefTask(const std::string& name);
 
    SetScalarDataRefTask(XPLMDataRef dataRef);
 
protected:
    virtual void process();
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetIntDataRefTask :
        public SetScalarDataRefTask<int, SetIntDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, int value);
 
    SetIntDataRefTask(const std::string& name);
 
    SetIntDataRefTask(XPLMDataRef dataRef);
 
    virtual void readValue(hu::varadiistvan::scpl::io::DataStream& stream);
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetFloatDataRefTask :
        public SetScalarDataRefTask<float, SetFloatDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, float value);
 
    SetFloatDataRefTask(const std::string& name);
 
    SetFloatDataRefTask(XPLMDataRef dataRef);
 
    virtual void readValue(hu::varadiistvan::scpl::io::DataStream& stream);
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetDoubleDataRefTask :
        public SetScalarDataRefTask<double, SetDoubleDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, double value);
 
    SetDoubleDataRefTask(const std::string& name);
 
    SetDoubleDataRefTask(XPLMDataRef dataRef);
 
    virtual void readValue(hu::varadiistvan::scpl::io::DataStream& stream);
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
class SetArrayDataRefTask : public SetDataRefTask
{
private:
    int count;
 
    int offset;
 
    T* value;
 
public:
    SetArrayDataRefTask(const std::string& name, int count, int offset = 0);
 
    SetArrayDataRefTask(XPLMDataRef dataRef, int count, int offset = 0);
 
    virtual ~SetArrayDataRefTask();
 
    virtual void readValue(hu::varadiistvan::scpl::io::DataStream& stream);
 
protected:
    virtual void process();
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetIntArrayDataRefTask :
    public SetArrayDataRefTask<int, SetIntArrayDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, int* value, int count, int offset);
 
    SetIntArrayDataRefTask(const std::string& name, int count, int offset = 0);
 
    SetIntArrayDataRefTask(XPLMDataRef dataRef, int count, int offset = 0);
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetFloatArrayDataRefTask :
    public SetArrayDataRefTask<float, SetFloatArrayDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, float* value, int count, int offset);
 
    SetFloatArrayDataRefTask(const std::string& name, int count, int offset = 0);
 
    SetFloatArrayDataRefTask(XPLMDataRef dataRef, int count, int offset = 0);
};
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
class SetByteArrayDataRefTask :
    public SetArrayDataRefTask<unsigned char, SetByteArrayDataRefTask>
{
public:
    static void setData(XPLMDataRef dataRef, unsigned char* value,
                        int count, int offset);
 
    SetByteArrayDataRefTask(const std::string& name, int count, int offset = 0);
 
    SetByteArrayDataRefTask(XPLMDataRef dataRef, int count, int offset = 0);
};
 
//------------------------------------------------------------------------------
// Template definitions
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
inline SetScalarDataRefTask<T, ConcreteClass>::
SetScalarDataRefTask(const std::string& name) :
    SetDataRefTask(name)
{
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
inline SetScalarDataRefTask<T, ConcreteClass>::
SetScalarDataRefTask(XPLMDataRef dataRef) :
    SetDataRefTask(dataRef)
{
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
void SetScalarDataRefTask<T, ConcreteClass>::process()
{
    ConcreteClass::setData(getDataRef(), value);
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
inline SetArrayDataRefTask<T, ConcreteClass>::
SetArrayDataRefTask(const std::string& name, int count, int offset) :
    SetDataRefTask(name),
    count(count),
    offset(offset),
    value(new T[count])
{
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
inline SetArrayDataRefTask<T, ConcreteClass>::
SetArrayDataRefTask(XPLMDataRef dataRef, int count, int offset) :
    SetDataRefTask(dataRef),
    count(count),
    offset(offset),
    value(new T[count])
{
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
inline SetArrayDataRefTask<T, ConcreteClass>::~SetArrayDataRefTask()
{
    delete [] value;
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
void SetArrayDataRefTask<T, ConcreteClass>::
readValue(hu::varadiistvan::scpl::io::DataStream& stream)
{
    stream.read(value, count * sizeof(T));
}
 
//------------------------------------------------------------------------------
 
template <typename T, class ConcreteClass>
void SetArrayDataRefTask<T, ConcreteClass>::process()
{
    ConcreteClass::setData(getDataRef(), value, count, offset);
}
 
//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------
 
inline SetDataRefTask::SetDataRefTask(const std::string& name) :
    DataRefTask(name)
{
}
 
//------------------------------------------------------------------------------
 
inline SetDataRefTask::SetDataRefTask(XPLMDataRef dataRef) :
    DataRefTask(dataRef)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetIntDataRefTask::setData(XPLMDataRef dataRef, int value)
{
    XPLMSetDatai(dataRef, value);
}
 
//------------------------------------------------------------------------------
 
inline SetIntDataRefTask::SetIntDataRefTask(const std::string& name) :
    SetScalarDataRefTask<int, SetIntDataRefTask>(name)
{
}
 
//------------------------------------------------------------------------------
 
inline SetIntDataRefTask::SetIntDataRefTask(XPLMDataRef dataRef) :
    SetScalarDataRefTask<int, SetIntDataRefTask>(dataRef)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetFloatDataRefTask::setData(XPLMDataRef dataRef, float value)
{
    XPLMSetDatai(dataRef, value);
}
 
//------------------------------------------------------------------------------
 
inline SetFloatDataRefTask::SetFloatDataRefTask(const std::string& name) :
    SetScalarDataRefTask<float, SetFloatDataRefTask>(name)
{
}
 
//------------------------------------------------------------------------------
 
inline SetFloatDataRefTask::SetFloatDataRefTask(XPLMDataRef dataRef) :
    SetScalarDataRefTask<float, SetFloatDataRefTask>(dataRef)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetDoubleDataRefTask::setData(XPLMDataRef dataRef, double value)
{
    XPLMSetDatai(dataRef, value);
}
 
//------------------------------------------------------------------------------
 
inline SetDoubleDataRefTask::SetDoubleDataRefTask(const std::string& name) :
    SetScalarDataRefTask<double, SetDoubleDataRefTask>(name)
{
}
 
//------------------------------------------------------------------------------
 
inline SetDoubleDataRefTask::SetDoubleDataRefTask(XPLMDataRef dataRef) :
    SetScalarDataRefTask<double, SetDoubleDataRefTask>(dataRef)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetIntArrayDataRefTask::setData(XPLMDataRef dataRef, int* value,
                                            int count, int offset)
{
    XPLMSetDatavi(dataRef, value, offset, count);
}
 
//------------------------------------------------------------------------------
 
inline SetIntArrayDataRefTask::SetIntArrayDataRefTask(const std::string& name,
                                                      int count, int offset) :
    SetArrayDataRefTask<int, SetIntArrayDataRefTask>(name, count, offset)
{
}
 
//------------------------------------------------------------------------------
 
inline SetIntArrayDataRefTask::SetIntArrayDataRefTask(XPLMDataRef dataRef,
                                                      int count, int offset) :
    SetArrayDataRefTask<int, SetIntArrayDataRefTask>(dataRef, count, offset)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetFloatArrayDataRefTask::setData(XPLMDataRef dataRef,
                                              float* value,
                                              int count, int offset)
{
    XPLMSetDatavf(dataRef, value, offset, count);
}
 
//------------------------------------------------------------------------------
 
inline
SetFloatArrayDataRefTask::SetFloatArrayDataRefTask(const std::string& name,
                                                   int count, int offset) :
    SetArrayDataRefTask<float, SetFloatArrayDataRefTask>(name, count, offset)
{
}
 
//------------------------------------------------------------------------------
 
inline
SetFloatArrayDataRefTask::SetFloatArrayDataRefTask(XPLMDataRef dataRef,
                                                   int count, int offset) :
    SetArrayDataRefTask<float, SetFloatArrayDataRefTask>(dataRef, count, offset)
{
}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
inline void SetByteArrayDataRefTask::setData(XPLMDataRef dataRef,
                                             unsigned char* value,
                                             int count, int offset)
{
    XPLMSetDatab(dataRef, value, offset, count);
}
 
//------------------------------------------------------------------------------
 
inline
SetByteArrayDataRefTask::SetByteArrayDataRefTask(const std::string& name,
                                                 int count, int offset) :
    SetArrayDataRefTask<unsigned char, SetByteArrayDataRefTask>(name,
                                                                count, offset)
{
}
 
//------------------------------------------------------------------------------
 
inline
SetByteArrayDataRefTask::SetByteArrayDataRefTask(XPLMDataRef dataRef,
                                                 int count, int offset) :
    SetArrayDataRefTask<unsigned char, SetByteArrayDataRefTask>(dataRef,
                                                                count, offset)
{
}
 
//------------------------------------------------------------------------------
 
} /* namespace xplra */
 
//------------------------------------------------------------------------------
#endif // XPLRA_SETDATAREFTASK_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: