ArgusSamples::AppModuleGeneric Class Reference

The base app module provides basic settings common to all app modules. More...

#include <AppModuleGeneric.h>

Inheritance diagram for ArgusSamples::AppModuleGeneric:

List of all members.

Public Member Functions
	AppModuleGeneric ()
virtual	~AppModuleGeneric ()
IAppModule methods
virtual bool	initialize (Options &options)
	Initialize.
virtual bool	shutdown ()
	Shut down.
virtual bool	start (Window::IGuiMenuBar *iGuiMenuBar=NULL, Window::IGuiContainer *iGuiContainerConfig=NULL)
	Start the module.
virtual bool	stop ()
	Stop the module.
Public Member Functions inherited from ArgusSamples::IAppModule
	IAppModule ()
virtual	~IAppModule ()

Static Public Member Functions
option callbacks
static bool	info (void *userPtr, const char *optArg)
static bool	loadConfig (void *userPtr, const char *optArg)
static bool	saveConfig (void *userPtr, const char *optArg)
static bool	quit (void *userPtr, const char *optArg)

Private Attributes
bool	m_initialized
	set if initialized
bool	m_running
	set if running
Window::IGuiMenuBar *	m_guiMenuBar
	menu bar
Window::IGuiContainer *	m_guiContainerConfig
	configuration GUI container
Window::IGuiContainerGrid *	m_guiConfig
	configuration GUI

---

Detailed Description

The base app module provides basic settings common to all app modules.

Definition at line 41 of file AppModuleGeneric.h.

---

Constructor & Destructor Documentation

ArgusSamples::AppModuleGeneric::AppModuleGeneric

(

)

Definition at line 86 of file AppModuleGeneric.cpp.

ArgusSamples::AppModuleGeneric::~AppModuleGeneric ( )

virtual

Definition at line 95 of file AppModuleGeneric.cpp.

---

Member Function Documentation

bool ArgusSamples::AppModuleGeneric::info ( void *  userPtr, const char *  optArg  )

static

Definition at line 49 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::initialize ( Options &  options )

virtual

Initialize.

Parameters:

[in]

options

each app module can add options

Implements ArgusSamples::IAppModule.

Definition at line 100 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::loadConfig ( void *  userPtr, const char *  optArg  )

static

Todo:

ask for file if called from GUI

Definition at line 58 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::quit ( void *  userPtr, const char *  optArg  )

static

Definition at line 80 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::saveConfig ( void *  userPtr, const char *  optArg  )

static

Todo:

ask for file if called from GUI

Definition at line 69 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::shutdown ( )

virtual

Shut down.

Implements ArgusSamples::IAppModule.

Definition at line 247 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::start ( Window::IGuiMenuBar *  iGuiMenuBar = NULL, Window::IGuiContainer *  iGuiContainerConfig = NULL  )

virtual

Start the module.

Parameters:

[in]	iGuiMenuBar	optional, the module can add menu items to this menu bar
[in]	iGuiContainerConfig	optional, the module can add configuration options to this container

Implements ArgusSamples::IAppModule.

Definition at line 262 of file AppModuleGeneric.cpp.

bool ArgusSamples::AppModuleGeneric::stop ( )

virtual

Stop the module.

Implements ArgusSamples::IAppModule.

Definition at line 399 of file AppModuleGeneric.cpp.

---

Member Data Documentation

Window::IGuiContainerGrid* ArgusSamples::AppModuleGeneric::m_guiConfig

private

configuration GUI

Definition at line 69 of file AppModuleGeneric.h.

Window::IGuiContainer* ArgusSamples::AppModuleGeneric::m_guiContainerConfig

private

configuration GUI container

Definition at line 68 of file AppModuleGeneric.h.

Window::IGuiMenuBar* ArgusSamples::AppModuleGeneric::m_guiMenuBar

private

menu bar

Definition at line 67 of file AppModuleGeneric.h.

bool ArgusSamples::AppModuleGeneric::m_initialized

private

set if initialized

Definition at line 65 of file AppModuleGeneric.h.

bool ArgusSamples::AppModuleGeneric::m_running

private

set if running

Definition at line 66 of file AppModuleGeneric.h.

---

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

• ui/common/AppModuleGeneric.h
• ui/common/AppModuleGeneric.cpp