mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-23 23:45:35 +08:00
794bf0cd74
The following issues were fixed * Fixed wrong/missing namespaces * Fixed obvious typos in documentation * Documentation not in sync with source code refs #544
83 lines
3.3 KiB
C++
83 lines
3.3 KiB
C++
/* 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/blackmiscexport.h"
|
|
#include "blackmisc/valueobject.h"
|
|
|
|
namespace BlackMisc
|
|
{
|
|
namespace Simulation
|
|
{
|
|
//! Describing a simulator plugin
|
|
class BLACKMISC_EXPORT CSimulatorPluginInfo : public BlackMisc::CValueObject<CSimulatorPluginInfo>
|
|
{
|
|
public:
|
|
//! Default constructor
|
|
CSimulatorPluginInfo() = default;
|
|
|
|
//! Constructor (used with unit tests)
|
|
CSimulatorPluginInfo(const QString &identifier, const QString &name,
|
|
const QString &simulator, const QString &description, bool valid);
|
|
|
|
//! \copydoc BlackMisc::CValueObject::convertFromJson
|
|
void convertFromJson(const QJsonObject &json);
|
|
|
|
//! Unspecified simulator
|
|
bool isUnspecified() const;
|
|
|
|
//! Check if the provided plugin metadata is valid.
|
|
//! Simulator plugin (driver) has to meet the following requirements:
|
|
//! * implements org.swift-project.blackcore.simulatorinterface;
|
|
//! * provides plugin name;
|
|
//! * specifies simulator it handles.
|
|
//! Unspecified sim is considered as invalid.
|
|
bool isValid() const { return m_valid; }
|
|
|
|
//! Identifier
|
|
const QString &getIdentifier() const { return m_identifier; }
|
|
|
|
//! Name
|
|
const QString &getName() const { return m_name; }
|
|
|
|
//! Simulator
|
|
const QString &getSimulator() const { return m_simulator; }
|
|
|
|
//! Description
|
|
const QString &getDescription() const { return m_description; }
|
|
|
|
//! \copydoc BlackMisc::Mixin::String::toQString
|
|
QString convertToQString(bool i18n = false) const;
|
|
|
|
private:
|
|
BLACK_ENABLE_TUPLE_CONVERSION(CSimulatorPluginInfo)
|
|
QString m_identifier;
|
|
QString m_name;
|
|
QString m_simulator;
|
|
QString m_description;
|
|
bool m_valid { false };
|
|
};
|
|
} // ns
|
|
} // ns
|
|
|
|
BLACK_DECLARE_TUPLE_CONVERSION(BlackMisc::Simulation::CSimulatorPluginInfo, (
|
|
attr(o.m_identifier, flags <CaseInsensitiveComparison> ()),
|
|
attr(o.m_name, flags < DisabledForComparison | DisabledForHashing > ()),
|
|
attr(o.m_simulator, flags < DisabledForComparison | DisabledForHashing > ()),
|
|
attr(o.m_description, flags < DisabledForComparison | DisabledForHashing > ()),
|
|
attr(o.m_valid, flags < DisabledForComparison | DisabledForHashing > ())
|
|
))
|
|
Q_DECLARE_METATYPE(BlackMisc::Simulation::CSimulatorPluginInfo)
|
|
|
|
#endif // guard
|