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

#include "ELdestination.h"

Public Member Functions
	~Config ()
	Config ()
	Config (fhicl::ParameterSet const &pset)

Static Public Member Functions
static std::string	limit_comment ()
static std::string	reportEvery_comment ()
static std::string	timespan_comment ()

Public Attributes
fhicl::Atom< int >	limit {fhicl::Name{"limit"}, -1}
fhicl::Atom< int >	reportEvery {fhicl::Name{"reportEvery"}, -1}
fhicl::Atom< int >	timespan {fhicl::Name{"timespan"}, -1}

Detailed Description

Definition at line 42 of file ELdestination.h.

Constructor & Destructor Documentation

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

default

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

(

)

Definition at line 39 of file ELdestination.cc.

References reportEvery, and timespan.

    : limit{fhicl::Name{"limit"}, -1}
    , reportEvery{fhicl::Name{"reportEvery"}, -1}
    , timespan{fhicl::Name{"timespan"}, -1}
  {}

mf::service::ELdestination::Category::Config::Config ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 45 of file ELdestination.cc.

References fhicl::ParameterSet::get(), reportEvery, and timespan.

    : limit{fhicl::Name{"limit"}, pset.get<int>("limit", -1)}
    , reportEvery{fhicl::Name{"reportEvery"}, pset.get<int>("reportEvery", -1)}
    , timespan{fhicl::Name{"timespan"}, pset.get<int>("timespan", -1)}
  {}

Member Function Documentation

std::string mf::service::ELdestination::Category::Config::limit_comment ( )

static

Definition at line 52 of file ELdestination.cc.

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

  {
    return R"(The 'limit' parameter is an integer after which the logger will start
to ignore messages of this category.  Beyond the specified limit, an
occasional further message will appear, based on an exponential
fall-off. For example, if the limit is set to 5, and 100 messages of
this category are issued, then the destination containing this
configuration will log messages numbered 1, 2, 3, 4, 5, 10, 15, 25,
45, and 85. A limit of zero disables reporting any messages.)";
  }

std::string mf::service::ELdestination::Category::Config::reportEvery_comment ( )

static

Definition at line 64 of file ELdestination.cc.

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

  {
    return R"(The 'reportEvery' parameter is an integer n which logs only every nth
message.  If the value is zero or less, then the report-every feature
is disabled.)";
  }

std::string mf::service::ELdestination::Category::Config::timespan_comment ( )

static

Definition at line 72 of file ELdestination.cc.

References mf::service::ELdestination::Category::Category(), mf::service::ELdestination::Category::~Category(), and mf::service::ELdestination::CategoryParams::~CategoryParams().

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

  {
    return R"(The 'timespan' parameter is an integer representing seconds.  When a
limit is set, one can also specify that if no occurrences for that
particular category of messages have been seen in a period of time
(the timespan), then the count toward that limit is to be reset. For
example, if one wish to suppress most of the thousands of warnings of
some category expected at startup, but would like to know if another
one happens after a gap of ten minutes, one can set the timespan value
to 600.  A value of zero or less disables the timespan functionality.)";
  }

Member Data Documentation

fhicl::Atom<int> mf::service::ELdestination::Category::Config::limit {fhicl::Name{"limit"}, -1}

Definition at line 51 of file ELdestination.h.

fhicl::Atom<int> mf::service::ELdestination::Category::Config::reportEvery {fhicl::Name{"reportEvery"}, -1}

Definition at line 52 of file ELdestination.h.

Referenced by Config().

fhicl::Atom<int> mf::service::ELdestination::Category::Config::timespan {fhicl::Name{"timespan"}, -1}

Definition at line 53 of file ELdestination.h.

Referenced by Config().

---

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

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