LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
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::Configformat
 
fhicl::OptionalDelegatedParameter categories
 
fhicl::Atom< bool > outputStatistics
 
fhicl::TableFragment< MsgStatistics::ConfigmsgStatistics
 

Detailed Description

Definition at line 152 of file ELdestination.h.

Constructor & Destructor Documentation

mf::service::ELdestination::Config::~Config ( )
default
mf::service::ELdestination::Config::Config ( )

Definition at line 229 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().

230  : dest_type{fhicl::Name{"type"}}
231  , threshold{fhicl::Name{"threshold"},
233  "The 'threshold' parameter specifies the lowest severity "
234  "level of\n"
235  "messages that will be logged to the destination"},
236  "INFO"}
237  , format{fhicl::Name{"format"}}
238  , categories{fhicl::Name{"categories"},
240  R"(The 'categories' parameter (if provided) is a FHiCL table that
241 configures the behavior of logging to this destination for the specified
242 category. For example, if the following appears in C++ source code:
243 
244  mf::LogInfo{"Tracking"} << my_track.diagnostics();
245 
246 the category is 'Tracking', and its behavior can be specified via:
247 
248  categories: {
249  Tracking: {
250  limit: -1 # default
251  reportEvery: -1 # default
252  timespan: -1 # default
253  }
254  }
255 
256 Within the 'categories' table, it is permitted to specify a 'default'
257 category, which becomes the configuration for all message categories
258 that are not explicitly listed.
259 
260 Note the categories listed only customize the behavior of messages
261 that are logged specifically to this destination. Messages that are
262 routed to other destinations are not be affected.
263 
264 Category parameters
265 ===================
266 
268  "\n\n" + Category::Config::reportEvery_comment() + "\n\n" +
270  , outputStatistics{fhicl::Name{"outputStatistics"}, false}
271  , msgStatistics{}
272  {}
fhicl::Table< MsgFormatSettings::Config > format
fhicl::TableFragment< MsgStatistics::Config > msgStatistics
fhicl::OptionalDelegatedParameter categories
fhicl::Atom< std::string > dest_type
fhicl::Atom< std::string > threshold
fhicl::Atom< bool > outputStatistics

Member Data Documentation

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

Definition at line 158 of file ELdestination.h.

Referenced by Config().

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

Definition at line 155 of file ELdestination.h.

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

Definition at line 157 of file ELdestination.h.

Referenced by Config().

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

Definition at line 160 of file ELdestination.h.

Referenced by Config().

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

Definition at line 159 of file ELdestination.h.

Referenced by Config().

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

Definition at line 156 of file ELdestination.h.

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


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