lar::example::Exploder Class Reference

A buggy module. More...

Inheritance diagram for lar::example::Exploder:

Classes
struct	Config

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	Exploder (Parameters const &config)
	Constructor. More...
virtual void	analyze (art::Event const &) override
	Executes the iterations. More...
Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDAnalyzer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept
	Analyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	Analyzer (Table< Config > const &config)
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Observer
	~Observer () noexcept
	Observer (Observer const &)=delete
	Observer (Observer &&)=delete
Observer &	operator= (Observer const &)=delete
Observer &	operator= (Observer &&)=delete
void	registerProducts (ProductDescriptions &, ModuleDescription const &)
void	fillDescriptions (ModuleDescription const &)
fhicl::ParameterSetID	selectorConfig () const
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Static Private Member Functions
static unsigned int	throwOutOfRange ()
	Throws a std::length_error exception. More...
static void	throwBadAlloc ()
	Throws a std::out_of_range exception. More...
static void	throwArtException ()
	Throws a std::out_of_range exception. More...

Private Attributes
bool	fManageBadAlloc
bool	fManageOutOfRange
bool	fManageArtException

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const
bool	wantAllEvents () const noexcept
bool	wantEvent (ScheduleID id, Event const &e) const
Handle< TriggerResults >	getTriggerResults (Event const &e) const
	Observer (fhicl::ParameterSet const &config)
	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

A buggy module.

This module executes a number of iterations. It does something in some of those iterations, depending on the module configuration.

Configuration

• NIterations (integer, default: 10): number of iterations executed
• OutOfRange (integer, optional): if specified, the module throws a std::out_of_range exception at the specified loop number

Definition at line 42 of file Exploder_module.cc.

Member Typedef Documentation

using lar::example::Exploder::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 67 of file Exploder_module.cc.

Constructor & Destructor Documentation

lar::example::Exploder::Exploder

(

Parameters const &

config

)

Constructor.

Definition at line 98 of file Exploder_module.cc.

  : art::EDAnalyzer(config)
  , fManageBadAlloc(config().ManageBadAlloc())
  , fManageOutOfRange(config().ManageOutOfRange())
  , fManageArtException(config().ManageArtException())
  {}

Member Function Documentation

void lar::example::Exploder::analyze ( art::Event const &  )

overridevirtual

Executes the iterations.

Implements art::EDAnalyzer.

Definition at line 107 of file Exploder_module.cc.

                                                {

  //
  // std::length_error
  //
  if (fManageBadAlloc) {
    try {
      throwBadAlloc();
    }
    catch (std::bad_alloc const&) {}
  }
  else {
    throwBadAlloc();
  }

  //
  // std::out_of_range
  //
  if (fManageOutOfRange) {
    try {
      throwOutOfRange();
    }
    catch (std::out_of_range const&) {}
  }
  else {
    throwOutOfRange();
  }

  //
  // art::Exception
  //
  if (fManageArtException) {
    try {
      throwArtException();
    }
    catch (art::Exception const&) {}
  }
  else {
    throwArtException();
  }

} // lar::example::Exploder::analyze()

void lar::example::Exploder::throwArtException ( )

staticprivate

Throws a std::out_of_range exception.

Definition at line 186 of file Exploder_module.cc.

                                           {

  throw art::Exception(art::errors::LogicError)
    << "I hate the world and I am vengeful.\n";

} // lar::example::Exploder::throwArtException()

void lar::example::Exploder::throwBadAlloc ( )

staticprivate

Throws a std::out_of_range exception.

Definition at line 171 of file Exploder_module.cc.

                                       {

  using OneMebibyte = std::array<unsigned char, 1048576U>;

  std::vector<OneMebibyte> manyMebibytes;

  // this is allowed, but we don't have enough memory
  mf::LogVerbatim("Exploder") << "Now allocating: " << manyMebibytes.max_size()
    << " x " << sizeof(OneMebibyte) << " bytes";
  manyMebibytes.resize(manyMebibytes.max_size());

} // lar::example::Exploder::throwBadAlloc()

unsigned int lar::example::Exploder::throwOutOfRange ( )

staticprivate

Throws a std::length_error exception.

Definition at line 152 of file Exploder_module.cc.

                                                 {

  std::vector<int> intData(5, 0);

  int intTotal = 0;
  for (unsigned int i = 0; i < 10; ++i) {
    mf::LogVerbatim("Exploder") << "Starting TOOR iteration #" << i;

    // possible std::out_of_range throw
    intTotal += intData.at(i);

  } // for
  mf::LogVerbatim("Exploder") << "TOOR iterations completed.";

  return intTotal;
} // lar::example::Exploder::throwOutOfRange()

Member Data Documentation

bool lar::example::Exploder::fManageArtException

private

Definition at line 80 of file Exploder_module.cc.

bool lar::example::Exploder::fManageBadAlloc

private

Definition at line 78 of file Exploder_module.cc.

bool lar::example::Exploder::fManageOutOfRange

private

Definition at line 79 of file Exploder_module.cc.

---

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

• larexamples/larexamples/DebuggingExamples/CatchException/Exploder_module.cc