SystemFrame Class Reference

#include <SystemFrame.h>

---

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 56 of file 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.

---

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 46 of file SystemFrame.cpp.

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

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

                                                    {
    oc.addOptionSubTopic("Configuration");

    oc.doRegister("configuration-file", 'c', new Option_FileName());
    oc.addSynonyme("configuration-file", "configuration");
    oc.addDescription("configuration-file", "Configuration", "Loads the named config on startup");

    oc.doRegister("save-configuration", new Option_FileName());
    oc.addSynonyme("save-config", "save-configuration");
    oc.addDescription("save-configuration", "Configuration", "Saves current configuration into FILE");

    oc.doRegister("save-template", new Option_FileName());
    oc.addDescription("save-template", "Configuration", "Saves a configuration template (empty) into FILE");

    /*
    oc.doRegister("save-template.mandatory-only", new Option_Bool(false));
    oc.addDescription("save-template.mandatory-only", "Configuration", "Saves only mandatory values into template");
    */

    oc.doRegister("save-template.commented", new Option_Bool(false));
    oc.addDescription("save-template.commented", "Configuration", "Adds comments to saved template");
}

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 71 of file SystemFrame.cpp.

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

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

                                             {
    oc.addOptionSubTopic("Report");

    oc.doRegister("verbose", 'v', new Option_Bool(false));
    oc.addDescription("verbose", "Report", "Switches to verbose output");

    oc.doRegister("print-options", 'p', new Option_Bool(false));
    oc.addDescription("print-options", "Report", "Prints option values before processing");

    oc.doRegister("help", '?', new Option_Bool(false));
    oc.addDescription("help", "Report", "Prints this screen");

    oc.doRegister("suppress-warnings", 'W', new Option_Bool(false));
    oc.addDescription("suppress-warnings", "Report", "Disables output of warnings");

    oc.doRegister("log-file", 'l', new Option_FileName());
    oc.addDescription("log-file", "Report", "Writes all messages to FILE");
}

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 92 of file SystemFrame.cpp.

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

Referenced by main().

                   {
    // close the xml-subsystem
    XMLSubSys::close();
    // delete build program options
    OptionsCont::getOptions().clear();
    // delete messages
    MsgHandler::cleanupOnEnd();
}

---

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

• SystemFrame.h
• SystemFrame.cpp