refs #396, move subproject BlackSim into BlackMisc::Simulation

* removed unused samples / tests
* fixed found Doxygen issues
* removed blacksimfreefunctions, now in BlackMisc::Simulation::registerMetadata()
* samples_vetcor_geo to samples_geo
This commit is contained in:
Klaus Basan
2015-04-03 18:17:54 +02:00
committed by Roland Winklmeier
parent a6ca57265e
commit 32f60722c8
148 changed files with 2577 additions and 2792 deletions

View File

@@ -0,0 +1,105 @@
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_SIMULATION_SIMULATORPLUGININFO_H
#define BLACKMISC_SIMULATION_SIMULATORPLUGININFO_H
#include "blackmisc/propertyindexvariantmap.h"
#include "blackmisc/valueobject.h"
namespace BlackMisc
{
namespace Simulation
{
//! Describing a simulator plugin
class CSimulatorPluginInfo : public BlackMisc::CValueObject<CSimulatorPluginInfo>
{
/**
* The _name_ property identifies the plugin itself and must be uniqe.
*/
Q_PROPERTY(QString getName READ getName)
/**
* The _simulator_ property specifies which simulator the plugin handles.
* There cannot be two plugins loaded for the same simulator.
* swift enables some features for particular simulators. Currently recognized are:
* fsx, fs9, xplane
*/
Q_PROPERTY(QString getSimulator READ getSimulator)
/**
* The _description_ property provides a short, human-readable description of the plugin.
*/
Q_PROPERTY(QString getDescription READ getDescription)
public:
//! Default constructor
CSimulatorPluginInfo() = default;
virtual void convertFromJson(const QJsonObject &json) override;
//! Unspecified simulator
bool isUnspecified() const;
//! Single setting value
BlackMisc::CVariant getSimulatorSetupValue(int index) const;
//! Single setting value
QString getSimulatorSetupValueAsString(int index) const;
//! Set single settings
void setSimulatorSetup(const BlackMisc::CPropertyIndexVariantMap &setup);
//! Check if the provided plugin metadata is valid.
//! Simulator plugin (driver) has to meet the following requirements:
//! * implements org.swift.pilotclient.BlackCore.SimulatorInterface;
//! * provides plugin name;
//! * specifies simulator it handles.
//! Unspecified sim is considered as invalid.
bool isValid() const { return m_valid; }
//! Equals
bool operator==(const CSimulatorPluginInfo &other) { return getName() == other.getName(); }
//! Name
const QString &getName() const { return m_name; }
//! Simulator
const QString &getSimulator() const { return m_simulator; }
//! Description
const QString &getDescription() const { return m_description; }
protected:
//! \copydoc CValueObject::convertToQString
virtual QString convertToQString(bool i18n = false) const override;
private:
BLACK_ENABLE_TUPLE_CONVERSION(CSimulatorPluginInfo)
QString m_name;
QString m_simulator;
QString m_description;
bool m_valid { false };
BlackMisc::CPropertyIndexVariantMap m_simsetup; //!< allows to access simulator keys requried on remote side
};
} // ns
} // ns
BLACK_DECLARE_TUPLE_CONVERSION(BlackMisc::Simulation::CSimulatorPluginInfo, (
attr(o.m_name),
attr(o.m_simulator),
attr(o.m_description),
attr(o.m_valid),
attr(o.m_simsetup, flags<DisabledForComparison>())
))
Q_DECLARE_METATYPE(BlackMisc::Simulation::CSimulatorPluginInfo)
#endif // guard