swift
Loading...
Searching...
No Matches
XSwiftBus::CPlugin Class Referencefinal

Main plugin class. More...

#include <plugin.h>

Inheritance diagram for XSwiftBus::CPlugin:
[legend]

Public Member Functions

 CPlugin ()
 Constructor.
 ~CPlugin ()
 Destructor.
void onAircraftModelChanged ()
 Called by XPluginReceiveMessage when the model is changed.
void onAircraftRepositioned ()
 Called by XPluginReceiveMessage when the aircraft is positioned at an airport.
void onSceneryLoaded ()
 Called by XPluginReceiveMessage when some scenery is loaded.
bool isRunning () const
 Is running.
bool shouldStop () const
 Should stop.
virtual const CConfig & getConfig () const
 Get settings from xswiftbus.conf (needed during plugin initialization).
virtual bool writeConfig (bool tcas, bool debug)
 Write a config file with these new values.
Public Member Functions inherited from XSwiftBus::CSettingsProvider
CSettings getSettings () const
 Get settings.
void setSettings (const CSettings &settings)
 Set settings.

Additional Inherited Members

Protected Member Functions inherited from XSwiftBus::CSettingsProvider
 ~CSettingsProvider ()=default
 Destructor.

Detailed Description

Main plugin class.

Definition at line 41 of file plugin.h.

Constructor & Destructor Documentation

◆ CPlugin()

XSwiftBus::CPlugin::CPlugin ( )

Constructor.

Definition at line 22 of file plugin.cpp.

◆ ~CPlugin()

XSwiftBus::CPlugin::~CPlugin ( )

Destructor.

Definition at line 62 of file plugin.cpp.

Member Function Documentation

◆ getConfig()

virtual const CConfig & XSwiftBus::CPlugin::getConfig ( ) const
inlinevirtual

Get settings from xswiftbus.conf (needed during plugin initialization).

Implements XSwiftBus::CSettingsProvider.

Definition at line 66 of file plugin.h.

◆ isRunning()

bool XSwiftBus::CPlugin::isRunning ( ) const
inline

Is running.

Definition at line 60 of file plugin.h.

◆ onAircraftModelChanged()

void XSwiftBus::CPlugin::onAircraftModelChanged ( )

Called by XPluginReceiveMessage when the model is changed.

Definition at line 145 of file plugin.cpp.

◆ onAircraftRepositioned()

void XSwiftBus::CPlugin::onAircraftRepositioned ( )

Called by XPluginReceiveMessage when the aircraft is positioned at an airport.

Definition at line 154 of file plugin.cpp.

◆ onSceneryLoaded()

void XSwiftBus::CPlugin::onSceneryLoaded ( )

Called by XPluginReceiveMessage when some scenery is loaded.

Definition at line 162 of file plugin.cpp.

◆ shouldStop()

bool XSwiftBus::CPlugin::shouldStop ( ) const
inline

Should stop.

Definition at line 63 of file plugin.h.

◆ writeConfig()

virtual bool XSwiftBus::CPlugin::writeConfig ( bool tcas,
bool debug )
inlinevirtual

Write a config file with these new values.

Implements XSwiftBus::CSettingsProvider.

Definition at line 69 of file plugin.h.


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