source: xplra/src/plugin/src/xplra/SaveSituationRequest.h@ 81:f28f1b8f3ef7

// 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_SAVESITUATIONREQUEST_H
#define XPLRA_SAVESITUATIONREQUEST_H
//------------------------------------------------------------------------------

#include "Request.h"

#include <string>

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

namespace xplra {

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

/**
 * A request that saves the current situation into a file.
 */
class SaveSituationRequest : public Request
{
private:
    /**
     * The path to save the situation into.
     */
    std::string path;

    /**
     * Indicate the success.
     */
    bool success;

public:
    /**
     * Construct the request.
     */
    SaveSituationRequest(const std::string& path);

    /**
     * Get the result.
     */
    bool getSuccess() const;

protected:
    /**
     * Execute the request.
     */
    virtual void execute();
};

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

inline SaveSituationRequest::SaveSituationRequest(const std::string& path) :
    path(path),
    success(false)
{
}

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

inline bool SaveSituationRequest::getSuccess() const
{
    return success;
}

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

} /* namespace xplra */

//------------------------------------------------------------------------------
#endif // XPLRA_SAVESITUATIONREQUEST_H

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