shawn::SimulationTaskLoggingLoadCfg Class Reference

Task that loads a logging library configuration file. More...

#include <logging_task_load_cfg.h>

Inheritance diagram for shawn::SimulationTaskLoggingLoadCfg:

Inheritance graph
[legend]
Collaboration diagram for shawn::SimulationTaskLoggingLoadCfg:

Collaboration graph
[legend]

List of all members.

Public Member Functions

construction / destruction
 SimulationTaskLoggingLoadCfg ()
virtual ~SimulationTaskLoggingLoadCfg ()
basic task methods
virtual void run (SimulationController &) throw ( std::runtime_error )
virtual std::string name (void) const throw ()
virtual std::string description (void) const throw ()


Detailed Description

Task that loads a logging library configuration file.

This task is able to load configuration files of both used logging libraries log4cxx and log4cplus. There is a working example in shawn/legacyapps/logging_demo/

Just type the following exemplary line to load a configuration file:

    logging_load_cfg log_cfg_file=MyCfgFile

Constructor & Destructor Documentation

shawn::SimulationTaskLoggingLoadCfg::SimulationTaskLoggingLoadCfg (  ) 

virtual shawn::SimulationTaskLoggingLoadCfg::~SimulationTaskLoggingLoadCfg (  )  [virtual]


Member Function Documentation

virtual void shawn::SimulationTaskLoggingLoadCfg::run ( SimulationController  )  throw ( std::runtime_error ) [virtual]

Main function which is called when starting this task. This case, configuration file with name log_cfg_file is loaded.

Parameters:
SimulationController enables access to whole simulation
See also:
SimulationTask::run()

Implements shawn::SimulationTask.

virtual std::string shawn::SimulationTaskLoggingLoadCfg::name ( void   )  const throw () [virtual]

Returns:
Name of task. This case logging_load_cfg
See also:
KeeperManaged::name()

Implements shawn::KeeperManaged.

virtual std::string shawn::SimulationTaskLoggingLoadCfg::description ( void   )  const throw () [virtual]

Returns:
Description of task.
See also:
KeeperManaged::description()

Implements shawn::KeeperManaged.


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

Generated on Tue Feb 7 00:00:56 2012 for Shawn by  doxygen 1.5.6