Ajax::Main Namespace Reference

The 'Main' namespace contains the start-up and and shutdown business logic for the Ajax application. More...

Detailed Description

The 'Main' namespace contains the start-up and and shutdown business logic for the Ajax application.

In addition is the 'base' Main Pattern that is for other application variants (e.g. See src/Eros/Main).

Classes
class	MetricsRecord
	This concrete class implements the "Record" class for storing user settings. More...
class	PersonalityRecord
	This concrete class implements the "Record" class for storing the 'Personality' settings. More...
class	TShellSecurity
	Validates the TShell login password. More...
class	UserRecord
	This concrete class implements the "Record" class for storing user settings. More...

Functions
void	appvariant_platform_initialize0 ()
	This method is used to initialize the Platform+Application variant.
void	appvariant_platform_initializeModelPoints0 ()
	This method is used to initialize the Platform+Application Variant model points to known state.
void	appvariant_platform_open0 ()
	This method is used to 'open' any Platform+Application Variant specific objects.
void	appvariant_platform_close0 ()
	This method is used to 'close' any Platform+Application variant specific objects.
void	appvariant_initialize0 ()
	This method is used to initialize the Application variant.
void	appvariant_initializeModelPoints0 ()
	This method is used to initialize the Application Variant model points to known state.
void	appvariant_open0 ()
	This method is used to 'open' any Application Variant specific objects.
void	appvariant_launchHomeScreen ()
	This method is use to launch the Application UI's home screen.
void	appvariant_close0 ()
	This method is used to 'close' any Application variant specific objects.
int	runTheApplication (Cpl::Io::Input &infd, Cpl::Io::Output &outfd)
	This method launches the start-up sequence, then runs the application, followed by the shutdown sequence.
void	platform_initialize0 ()
	This method is used to initialize 'stuff' immediately before an application initialization.
bool	platform_runPOST ()
	This method is used to execute platform specific POST test.
void	platform_initializeModelPoints0 ()
	This method is used to initialize the model points to known state.
void	platform_open0 ()
	This method is used to 'open' any platform specific objects.
void	platform_close0 ()
	This method is used to 'close' any platform specific objects.
int	platform_exit (int exitCode)
	This method is used to 'exit' the application'.

Variables
std::map< std::string, docopt::value >	g_args
	The simulator's command line arguments.
Cpl::Container::Map< Cpl::TShell::Command >	g_cmdlist
	Expose the TShell command list to facilitate creating platform specific TShell commands.
pimoroni::PicoGraphics_PenRGB332	g_graphics
	Expose the Graphic library (to faciliate static screen creation)
Ajax::ScreenMgr::Navigation &	g_screenNav
	Expose a handle to the global Screen Navigation instance.
Driver::NV::Api &	g_nvramDriver
	Expose the handle to the NV driver.
Driver::Crypto::Hash *	g_sha512Ptr
	Expose the Console hash function.
Cpl::Dm::MailboxServer	g_appMbox
	Expose the mailbox for the "application" thread (for Ajax this is the Algorithm thread)
Cpl::Dm::MailboxServer	g_uiMbox
	Expose the mailbox for the "UI" thread.
Driver::DIO::Pwm	g_heaterPWMDriver
	Expose the driver for the Heater PWM driver.
Driver::DIO::Pwm	g_fanPWMDriver
	Expose the driver for the Fan PWM driver.
Driver::DIO::In	g_hwSafetyDriver
	Expose the driver for the HW Safety Limit input driver.
Ajax::Ui::Home::Screen	g_homeScreen_
	Home Screen.
Ajax::Ui::EditSetpt::Screen	g_editSetptScreen_
	Edit setpoint Screen.
Ajax::Ui::About::Screen	g_aboutScreen_
	About Screen.
Ajax::Ui::Error::Screen	g_errorScreen_
	Error Screen.

Function Documentation

appvariant_close0()

void Ajax::Main::appvariant_close0

(

)

This method is used to 'close' any Application variant specific objects.

It is called AFTER to the application 'close' calls

appvariant_initialize0()

void Ajax::Main::appvariant_initialize0

(

)

This method is used to initialize the Application variant.

It is called BEFORE the common application initialization is performed.

appvariant_initializeModelPoints0()

void Ajax::Main::appvariant_initializeModelPoints0

(

)

This method is used to initialize the Application Variant model points to known state.

appvariant_launchHomeScreen()

void Ajax::Main::appvariant_launchHomeScreen

(

)

This method is use to launch the Application UI's home screen.

appvariant_open0()

void Ajax::Main::appvariant_open0

(

)

This method is used to 'open' any Application Variant specific objects.

It is called BEFORE the common application 'open' calls are made

appvariant_platform_close0()

void Ajax::Main::appvariant_platform_close0

(

)

This method is used to 'close' any Platform+Application variant specific objects.

It is called at the START of platform_close0().

appvariant_platform_initialize0()

void Ajax::Main::appvariant_platform_initialize0

(

)

This method is used to initialize the Platform+Application variant.

It is called at the END of platform_initialize0().

appvariant_platform_initializeModelPoints0()

void Ajax::Main::appvariant_platform_initializeModelPoints0

(

)

This method is used to initialize the Platform+Application Variant model points to known state.

It is called at the END of platform_initializeModelPoints0().

appvariant_platform_open0()

void Ajax::Main::appvariant_platform_open0

(

)

This method is used to 'open' any Platform+Application Variant specific objects.

It is called at the END of platform_open0().

platform_close0()

void Ajax::Main::platform_close0

(

)

This method is used to 'close' any platform specific objects.

It is called after to the application 'close' calls

platform_exit()

int Ajax::Main::platform_exit

(

int

exitCode

)

This method is used to 'exit' the application'.

platform_initialize0()

void Ajax::Main::platform_initialize0

(

)

This method is used to initialize 'stuff' immediately before an application initialization.

platform_initializeModelPoints0()

void Ajax::Main::platform_initializeModelPoints0

(

)

This method is used to initialize the model points to known state.

platform_open0()

void Ajax::Main::platform_open0

(

)

This method is used to 'open' any platform specific objects.

It is called prior to the application 'open' calls

platform_runPOST()

bool Ajax::Main::platform_runPOST

(

)

This method is used to execute platform specific POST test.

On error, the method returns false; else true is returned.

runTheApplication()

int Ajax::Main::runTheApplication	(	Cpl::Io::Input &	infd,
		Cpl::Io::Output &	outfd
	)

This method launches the start-up sequence, then runs the application, followed by the shutdown sequence.

The 'infd' and 'outfd' are the file descriptors to be used for the TShell/Command-Line-Interface.

NOTES: o The caller is responsible for calling Cpl::System::Api::initialize() o The caller of method MUST be executing in Cpl::System::Thread o This method ONLY returns once the shutdown sequence has been completed. o This method assumes that its thread is DEDICATED for performing the start-up/shutdown sequences. Once the start-up sequence has been completed, this thread stays blocked/in-the-waiting state until the Cpl::System::Shutdown interface is called to exit the application. All "shutdown handlers" will execute in this thread.

Variable Documentation

g_aboutScreen_

Ajax::Ui::About::Screen Ajax::Main::g_aboutScreen_

extern

About Screen.

g_appMbox

Cpl::Dm::MailboxServer Ajax::Main::g_appMbox

extern

Expose the mailbox for the "application" thread (for Ajax this is the Algorithm thread)

g_args

std::map<std::string, docopt::value> Ajax::Main::g_args

extern

The simulator's command line arguments.

g_cmdlist

Cpl::Container::Map<Cpl::TShell::Command> Ajax::Main::g_cmdlist

extern

Expose the TShell command list to facilitate creating platform specific TShell commands.

g_editSetptScreen_

Ajax::Ui::EditSetpt::Screen Ajax::Main::g_editSetptScreen_

extern

Edit setpoint Screen.

g_errorScreen_

Ajax::Ui::Error::Screen Ajax::Main::g_errorScreen_

extern

Error Screen.

g_fanPWMDriver

Driver::DIO::Pwm Ajax::Main::g_fanPWMDriver

extern

Expose the driver for the Fan PWM driver.

g_graphics

pimoroni::PicoGraphics_PenRGB332 Ajax::Main::g_graphics

extern

Expose the Graphic library (to faciliate static screen creation)

g_heaterPWMDriver

Driver::DIO::Pwm Ajax::Main::g_heaterPWMDriver

extern

Expose the driver for the Heater PWM driver.

g_homeScreen_

Ajax::Ui::Home::Screen Ajax::Main::g_homeScreen_

extern

Home Screen.

g_hwSafetyDriver

Driver::DIO::In Ajax::Main::g_hwSafetyDriver

extern

Expose the driver for the HW Safety Limit input driver.

g_nvramDriver

Driver::NV::Api& Ajax::Main::g_nvramDriver

extern

Expose the handle to the NV driver.

g_screenNav

Ajax::ScreenMgr::Navigation& Ajax::Main::g_screenNav

extern

Expose a handle to the global Screen Navigation instance.

g_sha512Ptr

Driver::Crypto::Hash* Ajax::Main::g_sha512Ptr

extern

Expose the Console hash function.

g_uiMbox

Cpl::Dm::MailboxServer Ajax::Main::g_uiMbox

extern

Expose the mailbox for the "UI" thread.