source: xplra/src/client/c/hu/varadiistvan/xplra/MultiGetter.h@ 19:280541440d22

// 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 HU_VARADIISTVAN_XPLRA_MULTIGETTER_H
#define HU_VARADIISTVAN_XPLRA_MULTIGETTER_H
//------------------------------------------------------------------------------

#include "MultiBuffer.h"

//------------------------------------------------------------------------------

namespace hu { namespace varadiistvan { namespace xplra {

//------------------------------------------------------------------------------

/**
 * A multi-dataref buffer used to query those data.
 */
class MultiGetter : public MultiBuffer
{
public:
    /**
     * Construct the object for the given XPlane instance.
     */
    MultiGetter(XPlane& xplane) throw();

protected:
    /**
     * @see MultiBuffer::doRegister
     */
    virtual uint8_t doRegister() throw(Exception);

    /**
     * @see MultiBuffer::doExecute
     */
    virtual void doExecute() throw(Exception);

    /**
     * @see MultiBuffer::doExecuteUnregistered
     */
    virtual void doExecuteUnregistered() throw(Exception);

private:
    /**
     * Read the value of the given dataref from the stream into the
     * buffer.
     */
    void read(const DataRef& dataRef) throw(Exception);
};

//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------

inline MultiGetter::MultiGetter(XPlane& xplane) throw() :
    MultiBuffer(xplane)
{
}

//------------------------------------------------------------------------------

} /* namespace hu::varadiistvan::xplra */ } /* namespace hu::varadiistvan */ } /* namespace hu */

//------------------------------------------------------------------------------
#endif // HU_VARADIISTVAN_XPLRA_MULTIGETTER_H

// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: