SystemFrame Class Reference

A set of actions common to all applications. More...

#include <SystemFrame.h>

Static Public Member Functions
static void	addConfigurationOptions (OptionsCont &oc)
	Adds configuration options to the given container.
static void	addReportOptions (OptionsCont &oc)
	Adds reporting options to the given container.
static void	close ()
	Closes all of an applications subsystems.

---

Detailed Description

A set of actions common to all applications.

As almost all applications within the SUMO-package share the same initialisation procedure, it is encapsulated within this class.

Only two things are done herein, so far. The first is to insert options into the given options container that are used for dealing with the application's configuration.

Additionally, a closing method may be found, which closes all used subsystems.

Definition at line 58 of file SystemFrame.h.

---

Member Function Documentation

void SystemFrame::addConfigurationOptions

(

OptionsCont &

oc

)

[static]

Adds configuration options to the given container.

Parameters:

[in]

oc

The options container to add the options to

Todo:

let the container be retrieved

Definition at line 49 of file SystemFrame.cpp.

References OptionsCont::addDescription(), OptionsCont::addOptionSubTopic(), OptionsCont::addSynonyme(), and OptionsCont::doRegister().

Referenced by ROJTRFrame::fillOptions(), RODUAFrame::fillOptions(), RODFFrame::fillOptions(), fillOptions(), MSFrame::fillOptions(), and AGFrame::fillOptions().

void SystemFrame::addReportOptions

(

OptionsCont &

oc

)

[static]

Adds reporting options to the given container.

Parameters:

[in]

oc

The options container to add the options to

Todo:

let the container be retrieved

Definition at line 73 of file SystemFrame.cpp.

References OptionsCont::addDescription(), OptionsCont::addOptionSubTopic(), OptionsCont::addSynonyme(), and OptionsCont::doRegister().

Referenced by ROJTRFrame::fillOptions(), RODUAFrame::fillOptions(), RODFFrame::fillOptions(), fillOptions(), MSFrame::fillOptions(), and AGFrame::fillOptions().

void SystemFrame::close

(

)

[static]

Closes all of an applications subsystems.

Closes (in this order)

• The xml subsystem
• The options subsystem
• The message subsystem

  See also:

  XMLSubSys::close()

  OptionsCont::clear()

  MsgHandler::cleanupOnEnd()

Definition at line 105 of file SystemFrame.cpp.

References MsgHandler::cleanupOnEnd(), OptionsCont::clear(), and OptionsCont::getOptions().

Referenced by main().

---

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

• SystemFrame.h
• SystemFrame.cpp