Prints on console the total Protons On Target from the input subruns. More...

Inheritance diagram for sim::POTaccumulator:

Classes
struct	Config
	Collection of configuration parameters for the module. More...

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
	Type to enable module parameters description by art. More...

using	ModuleType = EDAnalyzer

Public Member Functions
	POTaccumulator (Parameters const &config)
	Configuration-checking constructor. More...

	POTaccumulator (POTaccumulator const &)=delete

	POTaccumulator (POTaccumulator &&)=delete

POTaccumulator &	operator= (POTaccumulator const &)=delete

POTaccumulator &	operator= (POTaccumulator &&)=delete

virtual void	analyze (art::Event const &event) override

virtual void	endSubRun (art::SubRun const &subRun) override
	Collects information from each subrun. More...

virtual void	endJob () override
	Prints the general summary. More...

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)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

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 ()

Private Member Functions
void	printMissingSubrunList () const
	Prints the list of subruns with partial or missing POT information. More...

void	printRunSummary () const
	Prints the list of POT per run. More...

void	printSummary (sumdata::POTSummary const &totalPOT) const
	Prints the total POT summary `totalPOT`. More...

Static Private Member Functions
static std::string	to_string (sumdata::POTSummary const &POT)
	Converts the information from `POT` in a compact string. More...

Private Attributes
art::InputTag	fPOTtag
	Name of `sumdata::POTSummary` data product. More...

std::string	fSummaryOutputCategory
	Name of the main stream for output. More...

std::string	fRunOutputCategory
	Name of the run stream for output. More...

std::map< art::SubRunID, unsigned int >	fPresentSubrunFragments
	Count of subrun fragments with POT information. More...

std::map< art::SubRunID, unsigned int >	fMissingSubrunFragments
	Count of subrun fragments without POT information. More...

std::map< art::RunID, art::SummedValue< sumdata::POTSummary > >	fRunPOT
	Partial count of POT in the run, per run. More...

Detailed Description

Prints on console the total Protons On Target from the input subruns.

This module collects information from each of the subrun in the input files and prints the total of the protons on target. It also optionally prints the total for each observed run. If a subrun is met more than once, the information from all subrun fragments are added together (i.e. it is assumed that summary information is complementary rather than duplicate).

The output can be printed to the console or a file via the appropriate message facility configuration.

Two output streams are used: the one for the run summary and the one for the total summary. They may coincide.

Input

The module reads information from objects of type sumdata::POTSummary stored in each subrun.

Configuration

The output streams can be managed by configuring message facility to deal with the relevant category names. All messages are sent with the INFO level.

SummaryTag (input tag; default: generator): data product (subrun level) with the summary information;
SummaryCategory (string; default: POTaccumulator): the name of the output category the summary is sent to;
RunSummaryCategory (string; default: disabled): if specified, a summary POT is printed for each run; the summary is sent to the output stream specified by the value of this parameter.

Definition at line 71 of file POTaccumulator_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

using sim::POTaccumulator::Parameters = art::EDAnalyzer::Table<Config>

Type to enable module parameters description by art.

Definition at line 98 of file POTaccumulator_module.cc.

Constructor & Destructor Documentation

sim::POTaccumulator::POTaccumulator ( Parameters const & config )

explicit

Configuration-checking constructor.

Definition at line 158 of file POTaccumulator_module.cc.

   : EDAnalyzer(config)
   , fPOTtag(config().SummaryTag())
   , fSummaryOutputCategory(config().SummaryCategory())
   , fRunOutputCategory(config().RunSummaryCategory())
 {}

sim::POTaccumulator::POTaccumulator ( POTaccumulator const & )

delete

sim::POTaccumulator::POTaccumulator ( POTaccumulator && )

delete

Member Function Documentation

virtual void sim::POTaccumulator::analyze ( art::Event const & event )

inlineoverridevirtual

Implements art::EDAnalyzer.

Definition at line 110 of file POTaccumulator_module.cc.

References endJob(), and endSubRun().

110 {}

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::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
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void sim::POTaccumulator::endJob ( )

overridevirtual

Prints the general summary.

Reimplemented from art::EDAnalyzer.

Definition at line 197 of file POTaccumulator_module.cc.

References sumdata::POTSummary::aggregate(), fMissingSubrunFragments, fRunOutputCategory, fRunPOT, printMissingSubrunList(), printRunSummary(), printSummary(), and util::values().

Referenced by analyze().

 {
 
   //
   // print the run summary
   //
 
   if (!fRunOutputCategory.empty()) {
 
     if (!fMissingSubrunFragments.empty()) printMissingSubrunList();
 
     printRunSummary();
 
   } // if
 
   //
   // print the total summary
   //
 
   // here we skip _art_ aggregation mechanism
   // because it can't handle multiple runs
   sumdata::POTSummary totalPOT;
   for (auto const& POT : fRunPOT | ranges::views::values)
     totalPOT.aggregate(POT.value());
 
   printSummary(totalPOT);
 
 } // sim::POTaccumulator::endJob()

void sim::POTaccumulator::endSubRun ( art::SubRun const & subRun )

overridevirtual

Collects information from each subrun.

Reimplemented from art::EDAnalyzer.

Definition at line 166 of file POTaccumulator_module.cc.

References art::InputTag::encode(), fMissingSubrunFragments, fPOTtag, fPresentSubrunFragments, fRunPOT, fSummaryOutputCategory, art::ProductRetriever::getByLabel(), art::SubRun::id(), MF_LOG_TRACE, and to_string().

Referenced by analyze().

 {
 
   auto const& ID = subRun.id();
 
   //
   // get the information from the subrun and update the subrun counts
   //
   art::Handle<sumdata::POTSummary> summaryHandle;
   if (!subRun.getByLabel(fPOTtag, summaryHandle)) {
     ++fMissingSubrunFragments[ID];
     mf::LogDebug(fSummaryOutputCategory)
       << "Fragment of subrun " << ID << " has no '" << fPOTtag.encode() << "' POT summary.";
     return;
   }
 
   ++fPresentSubrunFragments[ID];
 
   //
   // accumulate the information by run
   //
   sumdata::POTSummary const& subRunPOT = *summaryHandle;
 
   fRunPOT[ID.runID()].update(summaryHandle);
   MF_LOG_TRACE(fSummaryOutputCategory)
     << "Fragment #" << fPresentSubrunFragments[ID] << " of subrun " << ID << ": "
     << sim::POTaccumulator::to_string(subRunPOT);
 
 } // sim::POTaccumulator::endSubRun()

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

POTaccumulator& sim::POTaccumulator::operator= ( POTaccumulator const & )

delete

POTaccumulator& sim::POTaccumulator::operator= ( POTaccumulator && )

delete

void sim::POTaccumulator::printMissingSubrunList ( ) const

private

Prints the list of subruns with partial or missing POT information.

Definition at line 227 of file POTaccumulator_module.cc.

References fMissingSubrunFragments, fPresentSubrunFragments, fRunOutputCategory, and util::size().

Referenced by endJob().

 {
 
   //
   // missing fragments information
   //
   mf::LogVerbatim log{fRunOutputCategory};
   log << size(fMissingSubrunFragments) << " subruns lack POT information:";
 
   auto const fend = fPresentSubrunFragments.cend();
 
   for (auto const& [id, nMissing] : fMissingSubrunFragments) {
 
     // add to the count of fragments the ones which we have actually found
     unsigned int nFragments = nMissing;
     auto const iFound = fPresentSubrunFragments.find(id);
     if (iFound != fend) nFragments += iFound->second;
 
     log << "\n" << id << ": " << nMissing << " / " << nFragments << " \"fragments\"";
 
   } // for
 
 } // sim::POTaccumulator::printMissingSubrunList()

void sim::POTaccumulator::printRunSummary ( ) const

private

Prints the list of POT per run.

Definition at line 252 of file POTaccumulator_module.cc.

References fPresentSubrunFragments, fRunOutputCategory, fRunPOT, util::size(), and to_string().

Referenced by endJob().

 {
 
   // count subruns in run
   std::map<art::RunID, unsigned int> subrunCount;
   for (art::SubRunID const& ID : fPresentSubrunFragments | ranges::views::keys)
     ++subrunCount[ID.runID()];
 
   mf::LogVerbatim log{fRunOutputCategory};
   log << "POT from " << size(fRunPOT) << " runs:";
   for (auto const& [id, POT] : fRunPOT) {
     log << "\n " << id << " (" << subrunCount[id]
         << " subruns): " << sim::POTaccumulator::to_string(POT.value());
   } // for
 
 } // sim::POTaccumulator::printRunSummary()

void sim::POTaccumulator::printSummary ( sumdata::POTSummary const & totalPOT ) const

private

Prints the total POT summary totalPOT.

Definition at line 270 of file POTaccumulator_module.cc.

References fPresentSubrunFragments, fRunPOT, fSummaryOutputCategory, and to_string().

Referenced by endJob().

 {
 
   // aggregate all run summaries
   mf::LogVerbatim{fSummaryOutputCategory}
     << "Aggregated POT from " << fRunPOT.size() << " runs (" << fPresentSubrunFragments.size()
     << " subruns): " << sim::POTaccumulator::to_string(totalPOT);
 
 } // sim::POTaccumulator::printSummary()

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

std::string sim::POTaccumulator::to_string ( sumdata::POTSummary const & POT )

staticprivate

Converts the information from POT in a compact string.

Definition at line 281 of file POTaccumulator_module.cc.

References DEFINE_ART_MODULE, sumdata::POTSummary::goodspills, util::to_string(), sumdata::POTSummary::totgoodpot, sumdata::POTSummary::totpot, and sumdata::POTSummary::totspills.

Referenced by endSubRun(), printRunSummary(), and printSummary().

 {
   using namespace std::string_literals;
   return std::to_string(POT.totgoodpot) + " good POT ( "s + std::to_string(POT.goodspills) +
          " spills); total: " + std::to_string(POT.totpot) + " POT ( "s +
          std::to_string(POT.totspills) + " spills)";
 } // sim::POTaccumulator::to_string(sumdata::POTSummary)

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

std::map<art::SubRunID, unsigned int> sim::POTaccumulator::fMissingSubrunFragments

private

Count of subrun fragments without POT information.

Definition at line 133 of file POTaccumulator_module.cc.

Referenced by endJob(), endSubRun(), and printMissingSubrunList().

art::InputTag sim::POTaccumulator::fPOTtag

private

Name of sumdata::POTSummary data product.

Definition at line 121 of file POTaccumulator_module.cc.

Referenced by endSubRun().

std::map<art::SubRunID, unsigned int> sim::POTaccumulator::fPresentSubrunFragments

private

Count of subrun fragments with POT information.

Definition at line 130 of file POTaccumulator_module.cc.

Referenced by endSubRun(), printMissingSubrunList(), printRunSummary(), and printSummary().

std::string sim::POTaccumulator::fRunOutputCategory

private

Name of the run stream for output.

Definition at line 123 of file POTaccumulator_module.cc.

Referenced by endJob(), printMissingSubrunList(), and printRunSummary().

std::map<art::RunID, art::SummedValue<sumdata::POTSummary> > sim::POTaccumulator::fRunPOT

private

Partial count of POT in the run, per run.

Definition at line 136 of file POTaccumulator_module.cc.

Referenced by endJob(), endSubRun(), printRunSummary(), and printSummary().

std::string sim::POTaccumulator::fSummaryOutputCategory

private

Name of the main stream for output.

Definition at line 122 of file POTaccumulator_module.cc.

Referenced by endSubRun(), and printSummary().

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

larsim/v09_43_00/source/larsim/EventGenerator/POTaccumulator_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Input

Configuration

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation