mf::service::ELdestination::Config Struct Reference

#include "ELdestination.h"

Public Member Functions
	~Config ()
	Config ()

Public Attributes
fhicl::Atom< std::string >	dest_type
fhicl::Atom< std::string >	threshold
fhicl::Table< MsgFormatSettings::Config >	format
fhicl::OptionalDelegatedParameter	categories
fhicl::Atom< bool >	outputStatistics
fhicl::TableFragment< MsgStatistics::Config >	msgStatistics

Detailed Description

Definition at line 177 of file ELdestination.h.

Constructor & Destructor Documentation

mf::service::ELdestination::Config::~Config

(

)

Definition at line 238 of file ELdestination.cc.

{}

mf::service::ELdestination::Config::Config

(

)

Definition at line 240 of file ELdestination.cc.

References categories, format, mf::service::ELdestination::Category::Config::limit_comment(), msgStatistics, outputStatistics, mf::service::ELdestination::Category::Config::reportEvery_comment(), threshold, and mf::service::ELdestination::Category::Config::timespan_comment().

      : dest_type{fhicl::Name{"type"}}
      , threshold{fhicl::Name{"threshold"},
                  fhicl::Comment{
                    "The 'threshold' parameter specifies the lowest severity "
                    "level of\n"
                    "messages that will be logged to the destination"},
                  "INFO"}
      , format{fhicl::Name{"format"}}
      , categories{fhicl::Name{"categories"},
                   fhicl::Comment{
                     R"(The 'categories' parameter (if provided) is a FHiCL table that
configures the behavior of logging to this destination for the specified
category.  For example, if the following appears in C++ source code:

  mf::LogInfo{"Tracking"} << my_track.diagnostics();

the category is 'Tracking', and its behavior can be specified via:

  categories: {
    Tracking: {
      limit: -1  # default
      reportEvery: -1 # default
      timespan: -1 # default
    }
  }

Within the 'categories' table, it is permitted to specify a 'default'
category, which becomes the configuration for all message categories
that are not explicitly listed.

Note the categories listed only customize the behavior of messages
that are logged specifically to this destination. Messages that are
routed to other destinations are not be affected.

Category parameters
===================

)" + Category::Config::limit_comment() +
                     "\n\n" + Category::Config::reportEvery_comment() + "\n\n" +
                     Category::Config::timespan_comment()}}
      , outputStatistics{fhicl::Name{"outputStatistics"}, false}
      , msgStatistics{}
    {}

Member Data Documentation

fhicl::OptionalDelegatedParameter mf::service::ELdestination::Config::categories

Definition at line 183 of file ELdestination.h.

Referenced by Config().

fhicl::Atom<std::string> mf::service::ELdestination::Config::dest_type

Definition at line 180 of file ELdestination.h.

fhicl::Table<MsgFormatSettings::Config> mf::service::ELdestination::Config::format

Definition at line 182 of file ELdestination.h.

Referenced by Config().

fhicl::TableFragment<MsgStatistics::Config> mf::service::ELdestination::Config::msgStatistics

Definition at line 185 of file ELdestination.h.

Referenced by Config().

fhicl::Atom<bool> mf::service::ELdestination::Config::outputStatistics

Definition at line 184 of file ELdestination.h.

Referenced by Config().

fhicl::Atom<std::string> mf::service::ELdestination::Config::threshold

Definition at line 181 of file ELdestination.h.

Referenced by Config(), and mf::service::ELdestination::ELdestination().

---

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

• messagefacility/MessageService/ELdestination.h
• messagefacility/MessageService/ELdestination.cc