MAKLogger::DtLoggerApplication Class Reference

The logger application class responsible for creating a logger, its gui and its console. More...

Collaboration diagram for MAKLogger::DtLoggerApplication:

Public Types
typedef void(*	GuiStartupCallback )(DtLgrAppGuiInterfaceSP)
	Callback function format. More...
typedef bool(*	WinEventFilterFunction )(tagMSG *msg, long *result)

Public Member Functions
	DtLoggerApplication ()
virtual	~DtLoggerApplication ()
virtual void	initialize (int argc, char **argv, DtString configFile)
	Initialize the logger. More...
virtual DtString	getConfigFilename (int argc, char **argv, DtString configFile)
	Get the config file name from the command line arguments or use the default which is 'lgrConfig.xml'. More...
virtual void	run ()
	Run the logger application. More...
DtString	language () const
	Get logger language. More...
virtual DtLgrAppGuiInterfaceSP	gui ()
	Pointer to the gui. More...
virtual DtLgrConsoleSP	console ()
	Pointer to the console. More...
virtual void	registerGuiStartupCallback (GuiStartupCallback callback)
	Register a gui startup callback. More...
virtual void	executeGuiStartupCallbacks ()
	Called by Gui interface after it has initialized. More...
virtual DtLoggerAppConfigLoader *	environmentLoader ()
virtual DtLogger &	logger ()
	Get a reference to the logger. More...
virtual const DtLogger &	logger () const
	Get a reference to the logger. More...

Static Public Member Functions
static WinEventFilterFunction	winEventFilter ()
static void	setWinEventFilter (WinEventFilterFunction function)
static void	initFPUnit ()
	Initilaize the Floating point unit to be 64 bits (needed on some platforms). More...

Protected Types
typedef std::list < GuiStartupCallback >	GuiStartupCallbackList

Protected Member Functions
void	setOutputLog (const DtString &logFilename)
	Set the output log file name. More...
virtual void	processConfigurationFile (const DtString &configFile)
	Process the configuration file. More...
virtual void	processCommandLineArguments (int argc, char **argv)
	Process the command line arguments. More...
virtual void	initializeGui ()
	Initialize the language. More...
virtual void	initializeConsole ()
	Initialize the command console. More...
virtual void	enableLoggerAppPlugins ()
	Enables all loaded plug-ins. More...

Protected Attributes
DtThreadedLoggerSP	myLogger
DtLgrConsoleSP	myConsole
DtLgrAppGuiInterfaceSP	myGui
DtLoggerAppConfigLoader *	myLoader
DtLgrAppCommandLine *	myCommandLine
DtString	myLogFileName
DtPrinter *	myLogFilePrinter
GuiStartupCallbackList	myStartupCallbacks

Static Protected Attributes
static WinEventFilterFunction	theCurrentWinEventFunction

Detailed Description

The logger application class responsible for creating a logger, its gui and its console.

Member Typedef Documentation

typedef void(* MAKLogger::DtLoggerApplication::GuiStartupCallback)(DtLgrAppGuiInterfaceSP)

Callback function format.

typedef std::list<GuiStartupCallback> MAKLogger::DtLoggerApplication::GuiStartupCallbackList

protected

typedef bool(* MAKLogger::DtLoggerApplication::WinEventFilterFunction)(tagMSG *msg, long *result)

Constructor & Destructor Documentation

MAKLogger::DtLoggerApplication::DtLoggerApplication

(

)

virtual MAKLogger::DtLoggerApplication::~DtLoggerApplication ( )

virtual

Member Function Documentation

virtual DtLgrConsoleSP MAKLogger::DtLoggerApplication::console ( )

virtual

Pointer to the console.

virtual void MAKLogger::DtLoggerApplication::enableLoggerAppPlugins ( )

protectedvirtual

Enables all loaded plug-ins.

Called at beginning of run(), and calls the enableLogger*Plugin functions passing in the Logger and LoggerApplication as necessary;

virtual DtLoggerAppConfigLoader* MAKLogger::DtLoggerApplication::environmentLoader ( )

virtual

virtual void MAKLogger::DtLoggerApplication::executeGuiStartupCallbacks ( )

virtual

Called by Gui interface after it has initialized.

virtual DtString MAKLogger::DtLoggerApplication::getConfigFilename ( int  argc, char **  argv, DtString  configFile  )

virtual

Get the config file name from the command line arguments or use the default which is 'lgrConfig.xml'.

virtual DtLgrAppGuiInterfaceSP MAKLogger::DtLoggerApplication::gui ( )

virtual

Pointer to the gui.

This pointer will be null is the GUI is not initialized.

static void MAKLogger::DtLoggerApplication::initFPUnit ( )

static

Initilaize the Floating point unit to be 64 bits (needed on some platforms).

virtual void MAKLogger::DtLoggerApplication::initialize ( int  argc, char **  argv, DtString  configFile  )

virtual

Initialize the logger.

This must be called before any other actions.

virtual void MAKLogger::DtLoggerApplication::initializeConsole ( )

protectedvirtual

Initialize the command console.

virtual void MAKLogger::DtLoggerApplication::initializeGui ( )

protectedvirtual

Initialize the language.

DtString MAKLogger::DtLoggerApplication::language

(

)

const

Get logger language.

virtual DtLogger& MAKLogger::DtLoggerApplication::logger ( )

virtual

Get a reference to the logger.

virtual const DtLogger& MAKLogger::DtLoggerApplication::logger ( ) const

virtual

Get a reference to the logger.

virtual void MAKLogger::DtLoggerApplication::processCommandLineArguments ( int  argc, char **  argv  )

protectedvirtual

Process the command line arguments.

virtual void MAKLogger::DtLoggerApplication::processConfigurationFile ( const DtString &  configFile )

protectedvirtual

Process the configuration file.

virtual void MAKLogger::DtLoggerApplication::registerGuiStartupCallback ( GuiStartupCallback  callback )

virtual

Register a gui startup callback.

virtual void MAKLogger::DtLoggerApplication::run ( )

virtual

Run the logger application.

The application must have bee initialized first via the initialize function.

void MAKLogger::DtLoggerApplication::setOutputLog ( const DtString &  logFilename )

protected

Set the output log file name.

Not virtual since called in CTOR.

static void MAKLogger::DtLoggerApplication::setWinEventFilter ( WinEventFilterFunction  function )

static

static WinEventFilterFunction MAKLogger::DtLoggerApplication::winEventFilter ( )

static

Member Data Documentation

DtLgrAppCommandLine* MAKLogger::DtLoggerApplication::myCommandLine

protected

DtLgrConsoleSP MAKLogger::DtLoggerApplication::myConsole

protected

DtLgrAppGuiInterfaceSP MAKLogger::DtLoggerApplication::myGui

protected

DtLoggerAppConfigLoader* MAKLogger::DtLoggerApplication::myLoader

protected

DtString MAKLogger::DtLoggerApplication::myLogFileName

protected

DtPrinter* MAKLogger::DtLoggerApplication::myLogFilePrinter

protected

DtThreadedLoggerSP MAKLogger::DtLoggerApplication::myLogger

protected

GuiStartupCallbackList MAKLogger::DtLoggerApplication::myStartupCallbacks

protected

WinEventFilterFunction MAKLogger::DtLoggerApplication::theCurrentWinEventFunction

staticprotected

---

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

• lgrApplication.h