logging_manager.h

Go to the documentation of this file.

/*
 *  logging_manager.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef LOGGING_MANAGER_H
#define LOGGING_MANAGER_H
 
// C++ includes:
#include <string>
#include <vector>
 
// Includes from libnestutil:
#include "dictionary.h"
#include "logging.h"
#include "manager_interface.h"
 
 
// Inclused from nestkernel:
#include "nest_names.h"
 
namespace nest
{
 
class LoggingEvent;
 
class LoggingManager : public ManagerInterface
{
public:
  LoggingManager();
  ~LoggingManager() override;
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
  void set_status( const Dictionary& ) override;
  void get_status( Dictionary& ) override;
 
  void register_logging_client( const deliver_logging_event_ptr callback );
 
  void
  publish_log( const VerbosityLevel, const std::string&, const std::string&, const std::string&, const size_t ) const;
 
  bool dict_miss_is_error() const;
 
  VerbosityLevel verbosity() const;
 
private:
  void deliver_logging_event_( const LoggingEvent& event ) const;
 
  void default_logging_callback_( const LoggingEvent& event ) const;
 
private:
  std::vector< deliver_logging_event_ptr > client_callbacks_;
  VerbosityLevel logging_level_;
  bool dict_miss_is_error_;  
};
 
inline bool
LoggingManager::dict_miss_is_error() const
{
  return dict_miss_is_error_;
}
 
inline VerbosityLevel
LoggingManager::verbosity() const
{
  return logging_level_;
}
 
}  // namespace nest
 
#endif /* ifndef LOGGING_MANAGER_H */