Application context interface. More...

Inheritance diagram for swift::core::context::IContextApplication:

Public Slots
virtual void	changeSettings (const misc::CValueCachePacket &settings, const misc::CIdentifier &origin)
	Ratify some settings changed by another process. More...

virtual misc::CValueCachePacket	getAllSettings () const =0
	Get all settings currently in core settings cache.

virtual QStringList	getUnsavedSettingsKeys () const =0
	Get keys of all unsaved settings currently in core settings cache.

virtual CSettingsDictionary	getUnsavedSettingsKeysDescribed () const =0
	Get keys and descriptions of all unsaved settings currently in core settings cache.

virtual void	synchronizeLocalSettings ()=0
	Update local settings with settings from core.

virtual misc::CStatusMessage	saveSettings (const QString &keyPrefix={})=0
	Save core settings to disk.

virtual misc::CStatusMessage	saveSettingsByKey (const QStringList &keys)=0
	Save core settings to disk.

virtual misc::CStatusMessage	loadSettings ()=0
	Load core settings from disk.

virtual void	registerHotkeyActions (const QStringList &actions, const misc::CIdentifier &origin)
	Register hotkey action implemented by another process. More...

virtual void	callHotkeyActionRemotely (const QString &action, bool argument, const misc::CIdentifier &origin)
	Call a hotkey action on a remote process. More...

virtual misc::CIdentifier	registerApplication (const misc::CIdentifier &application)=0
	Register application, can also be used for ping.

virtual void	unregisterApplication (const misc::CIdentifier &application)=0
	Unregister application.

virtual misc::CIdentifierList	getRegisteredApplications () const =0
	All registered applications.

virtual misc::CIdentifier	getApplicationIdentifier () const =0
	Identifier of application, remote side if distributed.

bool	parseCommandLine (const QString &commandLine, const swift::misc::CIdentifier &originator)
	Forward to facade.

Signals
void	registrationChanged ()
	A component changes.

void	settingsChanged (const swift::misc::CValueCachePacket &settings, const swift::misc::CIdentifier &origin)
	One or more settings were changed. More...

void	hotkeyActionsRegistered (const QStringList &actions, const swift::misc::CIdentifier &origin)
	New action was registered. More...

void	remoteHotkeyAction (const QString &action, bool argument, const swift::misc::CIdentifier &origin)
	Call a hotkey action on a remote process. More...

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...

	~IContextApplication ()=default
	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?

CCoreFacade *	getRuntime ()
	Runtime.

const CCoreFacade *	getRuntime () const
	Const runtime.

CCoreFacadeConfig::ContextMode	getMode () const
	Mode.

qint64	getUniqueId () const
	Unique id.

const IContextApplication *	getIContextApplication () const
	Context for application.

IContextApplication *	getIContextApplication ()
	Application.

IContextAudio *	getIContextAudio ()
	Context for network.

const IContextAudio *	getIContextAudio () const
	Context for network.

IContextNetwork *	getIContextNetwork ()
	Context for network.

const IContextNetwork *	getIContextNetwork () const
	Context for network.

IContextOwnAircraft *	getIContextOwnAircraft ()
	Context for own aircraft.

const IContextOwnAircraft *	getIContextOwnAircraft () const
	Context for own aircraft.

const IContextSimulator *	getIContextSimulator () const
	Context for simulator.

IContextSimulator *	getIContextSimulator ()
	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 IContextApplication *	create (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
	IContextApplication (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.

Static Protected Attributes
static constexpr int	PingIdentifiersMs = 20000
	how often identifiers are pinged

Additional Inherited Members
Static Protected Member Functions inherited from swift::core::context::IContext
static const misc::CStatusMessage &	statusMessageEmptyContext ()
	Standard message when status message is returned in empty context.

Detailed Description

Application context interface.

Definition at line 51 of file contextapplication.h.

Member Function Documentation

◆ callHotkeyActionRemotely

void swift::core::context::IContextApplication::callHotkeyActionRemotely	(	const QString &	action,
		bool	argument,
		const misc::CIdentifier &	origin
	)

virtualslot

Call a hotkey action on a remote process.

Note: Not pure because it can be called from the base class constructor.; This is the function which relays action calls via DBus

Definition at line 112 of file contextapplication.cpp.

◆ changeSettings

void swift::core::context::IContextApplication::changeSettings	(	const misc::CValueCachePacket &	settings,
		const misc::CIdentifier &	origin
	)

virtualslot

Ratify some settings changed by another process.

Note: Not pure because it can be called from the base class constructor.; This is the function which relays cache changes via DBus.

Definition at line 98 of file contextapplication.cpp.

◆ getPathAndContextId()

QString swift::core::context::IContextApplication::getPathAndContextId ( ) const

inlinevirtual

Id and path name for round trip protection.

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

Definition at line 72 of file contextapplication.h.

◆ hotkeyActionsRegistered

void swift::core::context::IContextApplication::hotkeyActionsRegistered	(	const QStringList &	actions,
		const swift::misc::CIdentifier &	origin
	)

signal

New action was registered.

Note: Used to register hotkey action, do not use directly

◆ registerHotkeyActions

void swift::core::context::IContextApplication::registerHotkeyActions	(	const QStringList &	actions,
		const misc::CIdentifier &	origin
	)

virtualslot

Register hotkey action implemented by another process.

Note: Not pure because it can be called from the base class constructor.; This is the function which relays action registrations via DBus

Definition at line 105 of file contextapplication.cpp.

◆ remoteHotkeyAction

void swift::core::context::IContextApplication::remoteHotkeyAction	(	const QString &	action,
		bool	argument,
		const swift::misc::CIdentifier &	origin
	)

signal

Call a hotkey action on a remote process.

Note: Used for hotkey action, do not use directly

◆ settingsChanged

void swift::core::context::IContextApplication::settingsChanged	(	const swift::misc::CValueCachePacket &	settings,
		const swift::misc::CIdentifier &	origin
	)

signal

One or more settings were changed.

Note: Used for cache relay, do not use directly

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

src/core/context/contextapplication.h
src/core/context/contextapplication.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ callHotkeyActionRemotely

◆ changeSettings

◆ getPathAndContextId()

◆ hotkeyActionsRegistered

◆ registerHotkeyActions

◆ remoteHotkeyAction

◆ settingsChanged