DCC-EX Simple Throttle
Simple throttle for a DCC-EX CommandStation
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AppConfiguration Class Reference

Class to perform all application configuration on startup All interfaces, menus, and other application objects are created within this class. More...

#include <AppConfiguration.h>

Collaboration diagram for AppConfiguration:
Collaboration graph
[legend]

Public Member Functions

 AppConfiguration ()
 Constructor for the app configuration object.
 
void initialise ()
 Start all associated user interfaces and instantiate all objects EventManager registrations are done here.
 
UserConfirmationInterfacegetUserConfirmationInterface ()
 Get the user confirmation interface associated with the config.
 
UserSelectionInterfacegetUserSelectionInterface ()
 Get the user selection interface associated with the config.
 
DisplayInterfacegetDisplayInterface ()
 Get the display interface associated with the config.
 
EventManagergetEventManager ()
 Get the event manager instance associated with the config.
 
AppOrchestratorgetAppOrchestrator ()
 Get the application orchestrator associated with the config.
 
ConnectionManagergetConnectionManager ()
 Get the connection manager.
 
MenuManagergetMenuManager ()
 Get the menu manager.
 
CommandStationClientgetCommandStationClient ()
 Get the CommandStation client.
 

Private Member Functions

void _registerEventSubscriptions ()
 Register all required event subscriptions, called by initialise()
 

Private Attributes

UserConfirmationInterface_userConfirmationInterface
 
UserSelectionInterface_userSelectionInterface
 
DisplayInterface_displayInterface
 
EventManager_eventManager
 
ConnectionManager_connectionManager
 
MenuManager_menuManager
 
CommandStationListener_commandStationListener
 
CommandStationClient_commandStationClient
 
ThrottleScreen_throttleScreen
 
AppOrchestrator_appOrchestrator
 

Detailed Description

Class to perform all application configuration on startup All interfaces, menus, and other application objects are created within this class.

Constructor & Destructor Documentation

◆ AppConfiguration()

AppConfiguration::AppConfiguration ( )

Constructor for the app configuration object.

Here is the call graph for this function:

Member Function Documentation

◆ _registerEventSubscriptions()

void AppConfiguration::_registerEventSubscriptions ( )
private

Register all required event subscriptions, called by initialise()

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAppOrchestrator()

AppOrchestrator * AppConfiguration::getAppOrchestrator ( )

Get the application orchestrator associated with the config.

Returns
Pointer to the application orchestrator

◆ getCommandStationClient()

CommandStationClient * AppConfiguration::getCommandStationClient ( )

Get the CommandStation client.

Returns
Pointer to the CommandStation client

◆ getConnectionManager()

ConnectionManager * AppConfiguration::getConnectionManager ( )

Get the connection manager.

Returns
Pointer to the connection manager

◆ getDisplayInterface()

DisplayInterface * AppConfiguration::getDisplayInterface ( )

Get the display interface associated with the config.

Returns
Pointer to the display interface

◆ getEventManager()

EventManager * AppConfiguration::getEventManager ( )

Get the event manager instance associated with the config.

Returns
Pointer to the event manager instance

◆ getMenuManager()

MenuManager * AppConfiguration::getMenuManager ( )

Get the menu manager.

Returns
Pointer to the menu manager

◆ getUserConfirmationInterface()

UserConfirmationInterface * AppConfiguration::getUserConfirmationInterface ( )

Get the user confirmation interface associated with the config.

Returns
Pointer to the user confirmation interface

◆ getUserSelectionInterface()

UserSelectionInterface * AppConfiguration::getUserSelectionInterface ( )

Get the user selection interface associated with the config.

Returns
Pointer to the user selection interface

◆ initialise()

void AppConfiguration::initialise ( )

Start all associated user interfaces and instantiate all objects EventManager registrations are done here.

Here is the call graph for this function:

Member Data Documentation

◆ _appOrchestrator

AppOrchestrator* AppConfiguration::_appOrchestrator
private

◆ _commandStationClient

CommandStationClient* AppConfiguration::_commandStationClient
private

◆ _commandStationListener

CommandStationListener* AppConfiguration::_commandStationListener
private

◆ _connectionManager

ConnectionManager* AppConfiguration::_connectionManager
private

◆ _displayInterface

DisplayInterface* AppConfiguration::_displayInterface
private

◆ _eventManager

EventManager* AppConfiguration::_eventManager
private

◆ _menuManager

MenuManager* AppConfiguration::_menuManager
private

◆ _throttleScreen

ThrottleScreen* AppConfiguration::_throttleScreen
private

◆ _userConfirmationInterface

UserConfirmationInterface* AppConfiguration::_userConfirmationInterface
private

◆ _userSelectionInterface

UserSelectionInterface* AppConfiguration::_userSelectionInterface
private

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