mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-23 23:45:35 +08:00
aa7363dcad
* connect with "about to quit" * added interface declarations * sim statistics, use common function setStatsRemoteAircraftUpdate and double for average values
284 lines
14 KiB
C++
284 lines
14 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 BLACKCORE_SIMULATOR_COMMON_H
|
|
#define BLACKCORE_SIMULATOR_COMMON_H
|
|
|
|
#include <QObject>
|
|
#include <QTimer>
|
|
#include <QReadWriteLock>
|
|
#include <QtGlobal>
|
|
|
|
#include "blackcore/aircraftmatcher.h"
|
|
#include "blackcore/blackcoreexport.h"
|
|
#include "blackcore/simulator.h"
|
|
#include "blackmisc/simulation/aircraftmodelsetloader.h"
|
|
#include "blackmisc/simulation/simulatedaircraftlist.h"
|
|
#include "blackmisc/simulation/simulatorinfo.h"
|
|
#include "blackmisc/simulation/simulatorplugininfo.h"
|
|
#include "blackmisc/simulation/simulatorinternals.h"
|
|
#include "blackmisc/simulation/settings/simulatorsettings.h"
|
|
#include "blackmisc/simulation/interpolationrenderingsetup.h"
|
|
#include "blackmisc/simulation/interpolationlogger.h"
|
|
#include "blackmisc/aviation/callsignset.h"
|
|
#include "blackmisc/pq/length.h"
|
|
#include "blackmisc/pq/time.h"
|
|
#include "blackmisc/pq/units.h"
|
|
#include "blackmisc/connectionguard.h"
|
|
|
|
namespace BlackMisc
|
|
{
|
|
class CSimpleCommandParser;
|
|
|
|
namespace Aviation
|
|
{
|
|
class CAircraftParts;
|
|
class CAircraftSituation;
|
|
class CCallsign;
|
|
}
|
|
namespace Simulation
|
|
{
|
|
class CAirspaceAircraftSnapshot;
|
|
class CSimulatedAircraft;
|
|
}
|
|
}
|
|
|
|
namespace BlackCore
|
|
{
|
|
//! Common base class with providers, interface and some base functionality
|
|
class BLACKCORE_EXPORT CSimulatorCommon : public ISimulator
|
|
{
|
|
Q_OBJECT
|
|
Q_INTERFACES(BlackCore::ISimulator)
|
|
Q_INTERFACES(BlackMisc::Simulation::ISimulationEnvironmentProvider)
|
|
Q_INTERFACES(BlackMisc::Simulation::IInterpolationSetupProvider)
|
|
|
|
public:
|
|
//! Log categories
|
|
static const BlackMisc::CLogCategoryList &getLogCategories();
|
|
|
|
//! Destructor
|
|
virtual ~CSimulatorCommon();
|
|
|
|
// --------- ISimulator implementations ------------
|
|
virtual void setInterpolationAndRenderingSetup(const BlackMisc::Simulation::CInterpolationAndRenderingSetupGlobal &setup) override;
|
|
virtual void highlightAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraftToHighlight, bool enableHighlight, const BlackMisc::PhysicalQuantities::CTime &displayTime) override;
|
|
virtual bool followAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual const BlackMisc::Simulation::CSimulatorInternals &getSimulatorInternals() const override;
|
|
virtual BlackMisc::Aviation::CAirportList getAirportsInRange() const override;
|
|
virtual void setWeatherActivated(bool activated) override;
|
|
virtual void unload() override;
|
|
virtual bool disconnectFrom() override;
|
|
virtual bool isShuttingDown() const override;
|
|
virtual bool logicallyReAddRemoteAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual BlackMisc::Aviation::CCallsignSet unrenderedEnabledAircraft() const override;
|
|
virtual BlackMisc::Aviation::CCallsignSet renderedDisabledAircraft() const override;
|
|
virtual int physicallyRemoveMultipleRemoteAircraft(const BlackMisc::Aviation::CCallsignSet &callsigns) override;
|
|
virtual int physicallyRemoveAllRemoteAircraft() override;
|
|
virtual void clearAllRemoteAircraftData() override;
|
|
virtual BlackMisc::CStatusMessageList debugVerifyStateAfterAllAircraftRemoved() const override;
|
|
|
|
//! \addtogroup swiftdotcommands
|
|
//! @{
|
|
//! <pre>
|
|
//! .drv unload unload plugin BlackCore::CSimulatorCommon
|
|
//! .drv logint callsign log interpolator for callsign BlackCore::CSimulatorCommon
|
|
//! .drv logint off no log information for interpolator BlackCore::CSimulatorCommon
|
|
//! .drv logint write write interpolator log to file BlackCore::CSimulatorCommon
|
|
//! .drv logint clear clear current log BlackCore::CSimulatorCommon
|
|
//! .drv pos callsign shows current position in simulator BlackCore::CSimulatorCommon
|
|
//! .drv spline|linear callsign interpolator spline or linear BlackCore::CSimulatorCommon
|
|
//! .drv aircraft readd callsign re-add (add again) aircraft BlackCore::CSimulatorCommon
|
|
//! .drv aircraft readd all re-add all aircraft BlackCore::CSimulatorCommon
|
|
//! .drv aircraft rm callsign remove aircraft BlackCore::CSimulatorCommon
|
|
//! </pre>
|
|
//! @}
|
|
//! \copydoc ISimulator::parseCommandLine
|
|
virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
|
|
// --------- ISimulator implementations ------------
|
|
|
|
//! Register help
|
|
static void registerHelp();
|
|
|
|
//! Reset the statistics counters
|
|
void resetAircraftStatistics();
|
|
|
|
//! Counter added aircraft
|
|
int getStatisticsPhysicallyAddedAircraft() const { return m_statsPhysicallyAddedAircraft; }
|
|
|
|
//! Counter removed aircraft
|
|
int getStatisticsPhysicallyRemovedAircraft() const { return m_statsPhysicallyRemovedAircraft; }
|
|
|
|
//! Average update time in ms
|
|
double getStatisticsAverageUpdateTimeMs() const { return m_statsUpdateAircraftTimeAvgMs; }
|
|
|
|
//! Total update time in ms
|
|
qint64 getStatisticsTotalUpdateTimeMs() const { return m_statsUpdateAircraftTimeTotalMs; }
|
|
|
|
//! Access to logger
|
|
const BlackMisc::Simulation::CInterpolationLogger &interpolationLogger() const { return m_interpolationLogger; }
|
|
|
|
//! The latest logged data formatted
|
|
QString latestLoggedDataFormatted(const BlackMisc::Aviation::CCallsign &cs) const;
|
|
|
|
protected:
|
|
//! Constructor
|
|
CSimulatorCommon(const BlackMisc::Simulation::CSimulatorPluginInfo &info,
|
|
BlackMisc::Simulation::IOwnAircraftProvider *ownAircraftProvider,
|
|
BlackMisc::Simulation::IRemoteAircraftProvider *remoteAircraftProvider,
|
|
BlackMisc::Weather::IWeatherGridProvider *weatherGridProvider,
|
|
BlackMisc::Network::IClientProvider *clientProvider,
|
|
QObject *parent);
|
|
|
|
//! \name Interface implementations, called from context
|
|
//! @{
|
|
virtual bool logicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft) override;
|
|
virtual bool logicallyRemoveRemoteAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
//! @}
|
|
|
|
//! \name When swift DB data are read
|
|
//! @{
|
|
virtual void onSwiftDbAllDataRead();
|
|
virtual void onSwiftDbModelMatchingEntitiesRead();
|
|
virtual void onSwiftDbAirportsRead();
|
|
//! @}
|
|
|
|
//! \name Connected with remote aircraft provider signals
|
|
//! @{
|
|
//! Recalculate the rendered aircraft, this happens when restrictions are applied (max. aircraft, range)
|
|
virtual void onRecalculatedRenderedAircraft(const BlackMisc::Simulation::CAirspaceAircraftSnapshot &snapshot);
|
|
//! @}
|
|
|
|
//! Max.airports in range
|
|
int maxAirportsInRange() const;
|
|
|
|
//! Full reset of state
|
|
//! \remark reset as it was unloaded without unloading
|
|
//! \sa ISimulator::clearAllRemoteAircraftData
|
|
virtual void reset();
|
|
|
|
//! Reset highlighting
|
|
void resetHighlighting();
|
|
|
|
//! Restore all highlighted aircraft
|
|
void stopHighlighting();
|
|
|
|
//! Inject weather grid to simulator
|
|
virtual void injectWeatherGrid(const BlackMisc::Weather::CWeatherGrid &weatherGrid) { Q_UNUSED(weatherGrid); }
|
|
|
|
//! Airports from web services
|
|
BlackMisc::Aviation::CAirportList getWebServiceAirports() const;
|
|
|
|
//! Airport from web services by ICAO code
|
|
BlackMisc::Aviation::CAirport getWebServiceAirport(const BlackMisc::Aviation::CAirportIcaoCode &icao) const;
|
|
|
|
//! Blink the highlighted aircraft
|
|
void blinkHighlightedAircraft();
|
|
|
|
//! Restore aircraft from the provider data
|
|
void resetAircraftFromProvider(const BlackMisc::Aviation::CCallsign &callsign);
|
|
|
|
//! Set own model
|
|
void reverseLookupAndUpdateOwnAircraftModel(const BlackMisc::Simulation::CAircraftModel &model);
|
|
|
|
//! Set own model
|
|
void reverseLookupAndUpdateOwnAircraftModel(const QString &modelString);
|
|
|
|
//! Reload weather settings
|
|
void reloadWeatherSettings();
|
|
|
|
//! Parse driver specific details for ISimulator::parseCommandLine
|
|
virtual bool parseDetails(const BlackMisc::CSimpleCommandParser &parser);
|
|
|
|
//! Display a debug log message based on BlackMisc::Simulation::CInterpolationAndRenderingSetup
|
|
//! remark shows log messages of functions calls
|
|
void debugLogMessage(const QString &msg) const;
|
|
|
|
//! Display a debug log message based on BlackMisc::Simulation::CInterpolationAndRenderingSetup
|
|
//! remark shows log messages of functions calls
|
|
void debugLogMessage(const QString &funcInfo, const QString &msg) const;
|
|
|
|
//! Show log messages?
|
|
bool showDebugLogMessage() const;
|
|
|
|
//! Slow timer used to highlight aircraft, can be used for other things too
|
|
virtual void oneSecondTimerTimeout();
|
|
|
|
//! Kill timer if id is valid
|
|
void safeKillTimer();
|
|
|
|
//! Info about invalid situation
|
|
QString getInvalidSituationLogMessage(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Simulation::CInterpolationStatus &status, const QString &details = {}) const;
|
|
|
|
//! Can a new log message be generated without generating a "message" overflow
|
|
//! \remark works per callsign
|
|
//! \remark use this function when there is a risk that a lot of log. messages will be generated in a short time
|
|
bool clampedLog(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::CStatusMessage &message);
|
|
|
|
//! Mark as justed logged
|
|
//! \remark touch, but also return if it can be logged
|
|
//! \remark use this function when there is a risk that a lot of log. messages will be generated in a short time
|
|
void removedClampedLog(const BlackMisc::Aviation::CCallsign &callsign);
|
|
|
|
//! Update stats and flags
|
|
void setStatsRemoteAircraftUpdate(qint64 startTime);
|
|
|
|
//! Lookup against DB data
|
|
static BlackMisc::Simulation::CAircraftModel reverseLookupModel(const BlackMisc::Simulation::CAircraftModel &model);
|
|
|
|
bool m_pausedSimFreezesInterpolation = false; //!< paused simulator will also pause interpolation (so AI aircraft will hold)
|
|
bool m_autoCalcAirportDistance = true; //!< automatically calculate airport distance and bearing
|
|
bool m_updateRemoteAircraftInProgress = false; //!< currently updating remote aircraft
|
|
int m_timerId = -1; //!< dispatch timer id
|
|
int m_statsUpdateAircraftRuns = 0; //!< statistics update count
|
|
qint64 m_statsUpdateAircraftTimeTotalMs = 0; //!< statistics total update time
|
|
double m_statsUpdateAircraftTimeAvgMs = 0; //!< statistics average update time
|
|
BlackMisc::Simulation::CSimulatorInternals m_simulatorInternals; //!< setup object
|
|
BlackMisc::Simulation::CInterpolationLogger m_interpolationLogger; //!< log.interpolation
|
|
QMap<BlackMisc::Aviation::CCallsign, qint64> m_clampedLogMsg; //!< when logged last so there, can be used so there is no log message overflow
|
|
|
|
// some optional functionality which can be used by the simulators as needed
|
|
BlackMisc::Simulation::CSimulatedAircraftList m_addAgainAircraftWhenRemoved; //!< add this model again when removed, normally used to change model
|
|
|
|
// weather
|
|
bool m_isWeatherActivated = false; //!< Is simulator weather activated?
|
|
BlackMisc::Geo::CCoordinateGeodetic m_lastWeatherPosition; //!< Own aircraft position at which weather was fetched and injected last
|
|
BlackMisc::CSetting<BlackMisc::Simulation::Settings::TSelectedWeatherScenario> m_weatherScenarioSettings { this, &CSimulatorCommon::reloadWeatherSettings }; //!< Selected weather scenario
|
|
|
|
private:
|
|
// remote aircraft provider ("rap") bound
|
|
void rapOnRecalculatedRenderedAircraft(const BlackMisc::Simulation::CAirspaceAircraftSnapshot &snapshot);
|
|
void rapOnRemoteProviderRemovedAircraft(const BlackMisc::Aviation::CCallsign &callsign);
|
|
|
|
// call with counters updated
|
|
void callPhysicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft);
|
|
void callPhysicallyRemoveRemoteAircraft(const BlackMisc::Aviation::CCallsign &remoteCallsign);
|
|
|
|
//! Display a logged situation in simulator
|
|
void displayLoggedSituationInSimulator(const BlackMisc::Aviation::CCallsign &cs, bool stopLogging, int times = 25);
|
|
|
|
bool m_blinkCycle = false; //!< used for highlighting
|
|
qint64 m_highlightEndTimeMsEpoch = 0; //!< end highlighting
|
|
int m_timerCounter = 0; //!< allows to calculate n seconds
|
|
QTimer m_oneSecondTimer; //!< multi purpose timer
|
|
BlackMisc::Simulation::CSimulatedAircraftList m_highlightedAircraft; //!< all other aircraft are to be ignored
|
|
BlackMisc::Aviation::CCallsignSet m_callsignsToBeRendered; //!< callsigns which will be rendered
|
|
BlackMisc::CConnectionGuard m_remoteAircraftProviderConnections; //!< connected signal/slots
|
|
|
|
// statistics values of how often those functions are called
|
|
// those are the added counters, overflow will not be an issue here (discussed in T171 review)
|
|
int m_statsPhysicallyAddedAircraft = 0; //!< statistics, how many aircraft added
|
|
int m_statsPhysicallyRemovedAircraft = 0; //!< statistics, how many aircraft removed
|
|
};
|
|
} // namespace
|
|
|
|
#endif // guard
|