swift
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
swift::core::context::IContextSimulator Class Referenceabstract

Network context. More...

Inheritance diagram for swift::core::context::IContextSimulator:
[legend]

Public Slots

virtual swift::misc::simulation::CSimulatorPluginInfo getSimulatorPluginInfo () const =0
 Simulator info, currently loaded plugin.
 
virtual swift::misc::simulation::CSimulatorPluginInfoList getAvailableSimulatorPlugins () const =0
 Return list of available simulator plugins.
 
virtual swift::misc::simulation::settings::CSimulatorSettings getSimulatorSettings () const =0
 Get the current simulator settings.
 
virtual bool setSimulatorSettings (const swift::misc::simulation::settings::CSimulatorSettings &settings, const swift::misc::simulation::CSimulatorInfo &simulator)=0
 Set settings for give simulator.
 
virtual int checkListeners ()=0
 Check all listeners enabled if simulator is connected.
 
virtual bool startSimulatorPlugin (const swift::misc::simulation::CSimulatorPluginInfo &simulatorInfo)=0
 Load and start specific simulator plugin.
 
virtual void stopSimulatorPlugin (const swift::misc::simulation::CSimulatorPluginInfo &simulatorInfo)=0
 Stop listener or unload the given plugin (if currently loaded)
 
virtual ISimulator::SimulatorStatus getSimulatorStatus () const =0
 Simulator combined status.
 
virtual swift::misc::simulation::CSimulatorInternals getSimulatorInternals () const =0
 Simulator setup.
 
virtual swift::misc::simulation::CAircraftModelList getModelSet () const =0
 Installed models in simulator eco system. More...
 
virtual swift::misc::simulation::CSimulatorInfo getModelSetLoaderSimulator () const =0
 Get the model set loader simulator directly.
 
virtual void setModelSetLoaderSimulator (const swift::misc::simulation::CSimulatorInfo &simulator)=0
 Set the model set loader simulator directly. More...
 
virtual swift::misc::simulation::CSimulatorInfo simulatorsWithInitializedModelSet () const =0
 Simulators which have an initialized model set.
 
virtual swift::misc::CStatusMessageList verifyPrerequisites () const =0
 Verify prerequisites for simulation like an existing model set. More...
 
virtual int getModelSetCount () const =0
 Number of installed models in simulator eco system.
 
virtual swift::misc::simulation::CAircraftModelList getModelSetModelsStartingWith (const QString &modelString) const =0
 Models for model string.
 
virtual QStringList getModelSetStrings () const =0
 Model strings.
 
virtual QStringList getModelSetCompleterStrings (bool sorted) const =0
 Model set completer string.
 
virtual int removeModelsFromSet (const swift::misc::simulation::CAircraftModelList &removeModels)=0
 Remove models from set.
 
virtual void disableModelsForMatching (const swift::misc::simulation::CAircraftModelList &removedModels, bool incremental)=0
 Remove a model for matching. More...
 
virtual swift::misc::simulation::CAircraftModelList getDisabledModelsForMatching () const =0
 The disabled models for matching. More...
 
virtual bool isValidationInProgress () const =0
 Validation in progress. More...
 
virtual bool triggerModelSetValidation (const swift::misc::simulation::CSimulatorInfo &simulator)=0
 Trigger model set validation.
 
virtual void restoreDisabledModels ()=0
 Restore the models removed with CAircraftMatcher::disableModelForMatching. More...
 
virtual bool isKnownModelInSet (const QString &modelstring) const =0
 Known model?
 
virtual swift::misc::simulation::CInterpolationAndRenderingSetupGlobal getInterpolationAndRenderingSetupGlobal () const =0
 The global setup. More...
 
virtual swift::misc::simulation::CInterpolationSetupList getInterpolationAndRenderingSetupsPerCallsign () const =0
 Get all setups per callsign. More...
 
virtual swift::misc::simulation::CInterpolationAndRenderingSetupPerCallsign getInterpolationAndRenderingSetupPerCallsignOrDefault (const swift::misc::aviation::CCallsign &callsign) const =0
 Get the setup for callsign, if not existing the global setup. More...
 
virtual void setInterpolationAndRenderingSetupGlobal (const swift::misc::simulation::CInterpolationAndRenderingSetupGlobal &setup)=0
 Set the global setup. More...
 
virtual bool setInterpolationAndRenderingSetupsPerCallsign (const swift::misc::simulation::CInterpolationSetupList &setups, bool ignoreSameAsGlobal)=0
 Set all setups per callsign. More...
 
virtual swift::misc::CStatusMessageList getInterpolationMessages (const swift::misc::aviation::CCallsign &callsign) const =0
 Interpolation messages.
 
bool isSimulatorAvailable () const
 Simulator avialable (driver available)?
 
bool isSimulatorSimulating () const
 Is available simulator simulating? Returns false if no simulator is available.
 
virtual swift::misc::CStatusMessageList getMatchingMessages (const swift::misc::aviation::CCallsign &callsign) const =0
 Get mapping messages.
 
virtual swift::misc::simulation::MatchingLog isMatchingMessagesEnabled () const =0
 Enabled mapping logging?
 
virtual void enableMatchingMessages (swift::misc::simulation::MatchingLog enabled)=0
 Enable mapping logging.
 
virtual bool followAircraft (const swift::misc::aviation::CCallsign &callsign)=0
 Follow aircraft im simulator view.
 
virtual void recalculateAllAircraft ()=0
 Recalculate all aircraft.
 
virtual bool resetToModelMatchingAircraft (const swift::misc::aviation::CCallsign &callsign)=0
 Reset model by matching it again.
 
virtual bool requestElevationBySituation (const swift::misc::aviation::CAircraftSituation &situation)=0
 Request elevation, there is no guarantee the requested elevation will be available in the provider. More...
 
virtual swift::misc::geo::CElevationPlane findClosestElevationWithinRange (const swift::misc::geo::CCoordinateGeodetic &reference, const swift::misc::physical_quantities::CLength &range) const =0
 Find closest elevation (or return NULL) More...
 
virtual int doMatchingsAgain ()=0
 Repeat all matchings.
 
virtual bool doMatchingAgain (const swift::misc::aviation::CCallsign &callsign)=0
 Repeat the matching callsign.
 
virtual swift::misc::simulation::CMatchingStatistics getCurrentMatchingStatistics (bool missingOnly) const =0
 Current matching statistics.
 
virtual void setMatchingSetup (const swift::misc::simulation::CAircraftMatcherSetup &setup)=0
 Set matching setup.
 
virtual bool testRemoteAircraft (const swift::misc::simulation::CSimulatedAircraft &aircraft, bool add)=0
 Test a remote aircraft.
 
virtual bool testUpdateRemoteAircraft (const swift::misc::aviation::CCallsign &cs, const swift::misc::aviation::CAircraftSituation &situation, const swift::misc::aviation::CAircraftParts &parts)=0
 Test update remote aircraft.
 
virtual swift::misc::simulation::CAircraftMatcherSetup getMatchingSetup () const =0
 Get matching setup.
 

Signals

void simulatorStatusChanged (int status)
 Simulator combined status. More...
 
void simulatorPluginChanged (const swift::misc::simulation::CSimulatorPluginInfo &info)
 Simulator plugin loaded / unloaded (default info)
 
void simulatorChanged (const swift::misc::simulation::CSimulatorInfo &simulator)
 Same as simulatorPluginChanged, only with simulator signature.
 
void simulatorSettingsChanged ()
 Simulator settings have been changed.
 
void vitalityLost ()
 A formerly vital driver is no longer vital/responding.
 
void insufficientFrameRateDetected (bool fatal)
 Frame rate has fallen too far below the threshold to maintain consistent sim rate.
 
void renderRestrictionsChanged (bool restricted, bool enabled, int maxAircraft, const swift::misc::physical_quantities::CLength &maxRenderedDistance)
 Render restrictions have been changed.
 
void interpolationAndRenderingSetupChanged ()
 Setup changed.
 
void matchingSetupChanged ()
 Matching setup changed.
 
void modelSetChanged (const swift::misc::simulation::CSimulatorInfo &simulator)
 Model set ready or changed.
 
void modelMatchingCompleted (const swift::misc::simulation::CSimulatedAircraft &aircraft)
 A single model has been matched for given aircraft.
 
void addingRemoteModelFailed (const swift::misc::simulation::CSimulatedAircraft &aircraft, bool disabled, bool failover, const swift::misc::CStatusMessage &message)
 Adding a remote aircraft failed.
 
void aircraftRenderingChanged (const swift::misc::simulation::CSimulatedAircraft &aircraft)
 Aircraft rendering changed.
 
void ownAircraftModelChanged (const swift::misc::simulation::CAircraftModel &model)
 Emitted when own aircraft model changes.
 
void airspaceSnapshotHandled ()
 An airspace snapshot was handled.
 
void driverMessages (const swift::misc::CStatusMessageList &messages)
 Relevant simulator messages to be explicitly displayed.
 
void validatedModelSet (const swift::misc::simulation::CSimulatorInfo &simulator, const swift::misc::simulation::CAircraftModelList &valid, const swift::misc::simulation::CAircraftModelList &invalid, bool stopped, const swift::misc::CStatusMessageList &msgs)
 Validated model set.
 
void autoPublishDataWritten (const swift::misc::simulation::CSimulatorInfo &simulator)
 Auto publish data written for simulator.
 
- Signals inherited from swift::core::context::IContext
void changedLogOrDebugSettings ()
 Log or debug values changed.
 

Public Member Functions

QString getPathAndContextId () const
 Id and path name for round trip protection. More...
 
 ~IContextSimulator ()
 Destructor.
 
- Public Member Functions inherited from swift::core::context::IContext
 ~IContext ()=default
 Destructor.
 
bool isUsingImplementingObject () const
 Using local implementing object?
 
bool isLocalObject () const
 Local or remote object?
 
bool isEmptyObject () const
 Empty object?
 
CCoreFacadegetRuntime ()
 Runtime.
 
const CCoreFacadegetRuntime () const
 Const runtime.
 
CCoreFacadeConfig::ContextMode getMode () const
 Mode.
 
qint64 getUniqueId () const
 Unique id.
 
const IContextApplicationgetIContextApplication () const
 Context for application.
 
IContextApplicationgetIContextApplication ()
 Application.
 
IContextAudiogetIContextAudio ()
 Context for network.
 
const IContextAudiogetIContextAudio () const
 Context for network.
 
IContextNetworkgetIContextNetwork ()
 Context for network.
 
const IContextNetworkgetIContextNetwork () const
 Context for network.
 
IContextOwnAircraftgetIContextOwnAircraft ()
 Context for own aircraft.
 
const IContextOwnAircraftgetIContextOwnAircraft () const
 Context for own aircraft.
 
const IContextSimulatorgetIContextSimulator () const
 Context for simulator.
 
IContextSimulatorgetIContextSimulator ()
 Simulator.
 
void setDebugEnabled (bool debug)
 Set debug flag.
 
bool isDebugEnabled () const
 Debug enabled?
 
virtual bool parseCommandLine (const QString &commandLine, const swift::misc::CIdentifier &originator)=0
 Parse a given command line.
 

Static Public Member Functions

static const QString & InterfaceName ()
 Service name.
 
static const QString & ObjectPath ()
 Service path.
 
static IContextSimulatorcreate (CCoreFacade *parent, CCoreFacadeConfig::ContextMode mode, swift::misc::CDBusServer *server, QDBusConnection &connection)
 Factory method.
 
- Static Public Member Functions inherited from swift::core::context::IContext
static const QStringList & getLogCategories ()
 Log categories.
 

Protected Member Functions

 IContextSimulator (CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime)
 Constructor.
 
- Protected Member Functions inherited from swift::core::context::IContext
 IContext (CCoreFacadeConfig::ContextMode mode, QObject *parent)
 Constructor.
 
QString buildPathAndContextId (const QString &path) const
 Path and context id.
 
void relayBaseClassSignals (const QString &serviceName, QDBusConnection &connection, const QString &objectPath, const QString &interfaceName)
 Relay signals from this class.
 
void logEmptyContextWarning (const QString &functionName) const
 Empty context called.
 
virtual void onAboutToShutdown ()
 Called when shutdown is about to be called.
 
void registerWithDBus (const QString &objectPath, misc::CDBusServer *server)
 Register myself in DBus.
 

Additional Inherited Members

- Static Protected Member Functions inherited from swift::core::context::IContext
static const misc::CStatusMessagestatusMessageEmptyContext ()
 Standard message when status message is returned in empty context.
 

Detailed Description

Network context.

Definition at line 54 of file contextsimulator.h.

Member Function Documentation

◆ disableModelsForMatching

virtual void swift::core::context::IContextSimulator::disableModelsForMatching ( const swift::misc::simulation::CAircraftModelList removedModels,
bool  incremental 
)
pure virtualslot

Remove a model for matching.

Remarks
effective until new set is set

◆ findClosestElevationWithinRange

virtual swift::misc::geo::CElevationPlane swift::core::context::IContextSimulator::findClosestElevationWithinRange ( const swift::misc::geo::CCoordinateGeodetic reference,
const swift::misc::physical_quantities::CLength range 
) const
pure virtualslot

Find closest elevation (or return NULL)

Remarks
This function is thread safe.

◆ getDisabledModelsForMatching

virtual swift::misc::simulation::CAircraftModelList swift::core::context::IContextSimulator::getDisabledModelsForMatching ( ) const
pure virtualslot

The disabled models for matching.

◆ getInterpolationAndRenderingSetupGlobal

virtual swift::misc::simulation::CInterpolationAndRenderingSetupGlobal swift::core::context::IContextSimulator::getInterpolationAndRenderingSetupGlobal ( ) const
pure virtualslot

The global setup.

Remarks
This function is thread safe.

◆ getInterpolationAndRenderingSetupPerCallsignOrDefault

virtual swift::misc::simulation::CInterpolationAndRenderingSetupPerCallsign swift::core::context::IContextSimulator::getInterpolationAndRenderingSetupPerCallsignOrDefault ( const swift::misc::aviation::CCallsign callsign) const
pure virtualslot

Get the setup for callsign, if not existing the global setup.

Remarks
This function is thread safe.

◆ getInterpolationAndRenderingSetupsPerCallsign

virtual swift::misc::simulation::CInterpolationSetupList swift::core::context::IContextSimulator::getInterpolationAndRenderingSetupsPerCallsign ( ) const
pure virtualslot

Get all setups per callsign.

Remarks
This function is thread safe.

◆ getModelSet

virtual swift::misc::simulation::CAircraftModelList swift::core::context::IContextSimulator::getModelSet ( ) const
pure virtualslot

Installed models in simulator eco system.

Note
might be slow since list can be big

◆ getPathAndContextId()

QString swift::core::context::IContextSimulator::getPathAndContextId ( ) const
inlinevirtual

Id and path name for round trip protection.

Implements swift::core::context::IContext.

Definition at line 67 of file contextsimulator.h.

◆ isValidationInProgress

virtual bool swift::core::context::IContextSimulator::isValidationInProgress ( ) const
pure virtualslot

Validation in progress.

Remarks
This function is thread safe.

◆ requestElevationBySituation

virtual bool swift::core::context::IContextSimulator::requestElevationBySituation ( const swift::misc::aviation::CAircraftSituation situation)
pure virtualslot

Request elevation, there is no guarantee the requested elevation will be available in the provider.

Remarks
This function is thread safe.

◆ restoreDisabledModels

virtual void swift::core::context::IContextSimulator::restoreDisabledModels ( )
pure virtualslot

Restore the models removed with CAircraftMatcher::disableModelForMatching.

◆ setInterpolationAndRenderingSetupGlobal

virtual void swift::core::context::IContextSimulator::setInterpolationAndRenderingSetupGlobal ( const swift::misc::simulation::CInterpolationAndRenderingSetupGlobal setup)
pure virtualslot

Set the global setup.

Remarks
This function is thread safe.

◆ setInterpolationAndRenderingSetupsPerCallsign

virtual bool swift::core::context::IContextSimulator::setInterpolationAndRenderingSetupsPerCallsign ( const swift::misc::simulation::CInterpolationSetupList &  setups,
bool  ignoreSameAsGlobal 
)
pure virtualslot

Set all setups per callsign.

Remarks
This function is thread safe.

◆ setModelSetLoaderSimulator

virtual void swift::core::context::IContextSimulator::setModelSetLoaderSimulator ( const swift::misc::simulation::CSimulatorInfo simulator)
pure virtualslot

Set the model set loader simulator directly.

Note
for testing purposes and can be used if no simulator is connected

◆ simulatorStatusChanged

void swift::core::context::IContextSimulator::simulatorStatusChanged ( int  status)
signal

Simulator combined status.

See also
ISimulator::SimulatorStatus
Remarks
still int for DBus

◆ verifyPrerequisites

virtual swift::misc::CStatusMessageList swift::core::context::IContextSimulator::verifyPrerequisites ( ) const
pure virtualslot

Verify prerequisites for simulation like an existing model set.

Precondition
system needs to be initialized to work correctly

The documentation for this class was generated from the following files: