AppOrchestrator Class Reference

This class is for the overall application orchestration to coordinate all the user interactions, screens, displays, connection management, and other application states. More...

#include <AppOrchestrator.h>

Inheritance diagram for AppOrchestrator:

Collaboration diagram for AppOrchestrator:

Public Member Functions
	AppOrchestrator (DisplayInterface *displayInterface, ConnectionManager *connectionManager, MenuManager *menuManager, CommandStationClient *commandStationClient, UserConfirmationInterface *userConfirmationInterface, UserSelectionInterface *userSelectionInterface, ThrottleScreen *throttleScreen)
	Constructor for the application orchestrator object.
void	begin ()
	Anything required to be initiated when the orchestrator starts is called here.
void	update ()
	Call this method at least once per main loop iteration to monitor for user interactions, ensure the display is updated, and connections are managed.
void	onEvent (Event &event)
	Implementation of the EventListener to respond to subscribed events.
void	setupSelectLocoMenu ()
	Method to setup the roster list in the SelectLocoMenu when the roster has been received.
void	setThrottleLoco (Loco *loco)
	Set the loco being managed by the throttle screen.
void	updateThrottleLoco (LocoBroadcast locoBroadcast)
	Notify the throttle screen an update has been received for the associated loco.
void	updateThrottleTrackPower (TrackPower trackPower)
	Notify the throttle screen of a track power update.

Private Member Functions
void	_handleStartupState ()
	Show the startup screen and wait for user interaction before continuing.
void	_handleSelectCommandStationState ()
	Display the CommandStation menu and process user interaction to select one.
void	_handleConnectCommandStationState ()
	Show the connection progress screen until a connection is made.
void	_handleSelectLocoState ()
	Show the loco selection menu and process user interaction to select one.
void	_handleThrottleState ()
	Show the throttle screen and process user interaction with the throttle.
void	_handleSelectActionState ()
	Show the select action menu and process user interaction to select one.
void	_handleErrorState ()
	Show any errors on screen and process user interaction to recover.
void	_switchState (AppState appState)
	Switch application states.
void	_displayMenu (BaseMenu *menu)
	Display a menu.
void	_handleJoinProgTrack ()
	Join programming track to main and return to the Select Loco menu.
void	_handleSetTrackPower (Event event)
	Set track power according to the provided Event details.
void	_readLoco ()
	Send read loco command to CommandStation client and set ReadLoco state for progress.
void	_handleReadLocoState ()
	Show the read loco progress screen until it is read or times out.
void	_handleReceivedReadLoco (int address)
	Set throttle to the received loco address when reading, or return to the select screen if failed.

Private Attributes
DisplayInterface *	_displayInterface
ConnectionManager *	_connectionManager
MenuManager *	_menuManager
CommandStationClient *	_commandStationClient
UserConfirmationInterface *	_userConfirmationInterface
UserSelectionInterface *	_userSelectionInterface
AppState	_currentAppState
StartupScreen *	_startupScreen
ThrottleScreen *	_throttleScreen
ErrorScreen *	_errorScreen
ProgressScreen *	_progressScreen

Detailed Description

This class is for the overall application orchestration to coordinate all the user interactions, screens, displays, connection management, and other application states.

Constructor & Destructor Documentation

AppOrchestrator()

AppOrchestrator::AppOrchestrator	(	DisplayInterface *	displayInterface,
		ConnectionManager *	connectionManager,
		MenuManager *	menuManager,
		CommandStationClient *	commandStationClient,
		UserConfirmationInterface *	userConfirmationInterface,
		UserSelectionInterface *	userSelectionInterface,
		ThrottleScreen *	throttleScreen
	)

Constructor for the application orchestrator object.

Parameters

displayInterface	Pointer to the display interface to ensure is updated
connectionManager	Pointer to the connection manager
menuManager	Pointer to the menu manager
commandStationClient	Pointer to the CommandStation client
userConfirmationInterface	Pointer to the user confirmation interface to monitor
userSelectionInterface	Pointer the user selection interface to monitor
throttleScreen	Pointer to the throttle screen

Member Function Documentation

_displayMenu()

void AppOrchestrator::_displayMenu ( BaseMenu *  menu )

private

Display a menu.

Parameters

menu	Pointer to the menu to be displayed

Here is the call graph for this function:

Here is the caller graph for this function:

_handleConnectCommandStationState()

void AppOrchestrator::_handleConnectCommandStationState ( )

private

Show the connection progress screen until a connection is made.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleErrorState()

void AppOrchestrator::_handleErrorState ( )

private

Show any errors on screen and process user interaction to recover.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleJoinProgTrack()

void AppOrchestrator::_handleJoinProgTrack ( )

private

Join programming track to main and return to the Select Loco menu.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleReadLocoState()

void AppOrchestrator::_handleReadLocoState ( )

private

Show the read loco progress screen until it is read or times out.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleReceivedReadLoco()

void AppOrchestrator::_handleReceivedReadLoco ( int  address )

private

Set throttle to the received loco address when reading, or return to the select screen if failed.

Parameters

address

DCC address of the loco read from the programming track, or -1 says fail

Here is the call graph for this function:

Here is the caller graph for this function:

_handleSelectActionState()

void AppOrchestrator::_handleSelectActionState ( )

private

Show the select action menu and process user interaction to select one.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleSelectCommandStationState()

void AppOrchestrator::_handleSelectCommandStationState ( )

private

Display the CommandStation menu and process user interaction to select one.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleSelectLocoState()

void AppOrchestrator::_handleSelectLocoState ( )

private

Show the loco selection menu and process user interaction to select one.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleSetTrackPower()

void AppOrchestrator::_handleSetTrackPower ( Event  event )

private

Set track power according to the provided Event details.

Parameters

eventType

Valid Event

Here is the call graph for this function:

Here is the caller graph for this function:

_handleStartupState()

void AppOrchestrator::_handleStartupState ( )

private

Show the startup screen and wait for user interaction before continuing.

Here is the call graph for this function:

Here is the caller graph for this function:

_handleThrottleState()

void AppOrchestrator::_handleThrottleState ( )

private

Show the throttle screen and process user interaction with the throttle.

Here is the call graph for this function:

Here is the caller graph for this function:

_readLoco()

void AppOrchestrator::_readLoco ( )

private

Send read loco command to CommandStation client and set ReadLoco state for progress.

Here is the call graph for this function:

Here is the caller graph for this function:

_switchState()

void AppOrchestrator::_switchState ( AppState  appState )

private

Switch application states.

Parameters

appState

State to switch to

Here is the call graph for this function:

Here is the caller graph for this function:

begin()

void AppOrchestrator::begin

(

)

Anything required to be initiated when the orchestrator starts is called here.

onEvent()

void AppOrchestrator::onEvent ( Event &  event )

virtual

Implementation of the EventListener to respond to subscribed events.

Parameters

event

Valid Event

Implements EventListener.

Here is the call graph for this function:

setThrottleLoco()

void AppOrchestrator::setThrottleLoco

(

Loco *

loco

)

Set the loco being managed by the throttle screen.

Parameters

loco	Pointer to the loco object

Here is the call graph for this function:

Here is the caller graph for this function:

setupSelectLocoMenu()

void AppOrchestrator::setupSelectLocoMenu

(

)

Method to setup the roster list in the SelectLocoMenu when the roster has been received.

Here is the call graph for this function:

Here is the caller graph for this function:

update()

void AppOrchestrator::update

(

)

Call this method at least once per main loop iteration to monitor for user interactions, ensure the display is updated, and connections are managed.

Here is the call graph for this function:

updateThrottleLoco()

void AppOrchestrator::updateThrottleLoco

(

LocoBroadcast

locoBroadcast

)

Notify the throttle screen an update has been received for the associated loco.

Parameters

locoBroadcast

Loco broadcast data containing address, speed, direction, and function map

Here is the call graph for this function:

Here is the caller graph for this function:

updateThrottleTrackPower()

void AppOrchestrator::updateThrottleTrackPower

(

TrackPower

trackPower

)

Notify the throttle screen of a track power update.

Parameters

trackPower

Track power state

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_commandStationClient

CommandStationClient* AppOrchestrator::_commandStationClient

private

_connectionManager

ConnectionManager* AppOrchestrator::_connectionManager

private

_currentAppState

AppState AppOrchestrator::_currentAppState

private

_displayInterface

DisplayInterface* AppOrchestrator::_displayInterface

private

_errorScreen

ErrorScreen* AppOrchestrator::_errorScreen

private

_menuManager

MenuManager* AppOrchestrator::_menuManager

private

_progressScreen

ProgressScreen* AppOrchestrator::_progressScreen

private

_startupScreen

StartupScreen* AppOrchestrator::_startupScreen

private

_throttleScreen

ThrottleScreen* AppOrchestrator::_throttleScreen

private

_userConfirmationInterface

UserConfirmationInterface* AppOrchestrator::_userConfirmationInterface

private

_userSelectionInterface

UserSelectionInterface* AppOrchestrator::_userSelectionInterface

private

---

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

• /home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/AppOrchestrator.h
• /home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/AppOrchestrator.cpp