sim::DumpSimChannels Class Reference

Inheritance diagram for sim::DumpSimChannels:

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

Public Member Functions
	DumpSimChannels (Parameters const &config)
	Configuration-checking constructor. More...
	DumpSimChannels (DumpSimChannels const &)=delete
	DumpSimChannels (DumpSimChannels &&)=delete
DumpSimChannels &	operator= (DumpSimChannels const &)=delete
DumpSimChannels &	operator= (DumpSimChannels &&)=delete
void	analyze (art::Event const &event) override
template<typename Stream >
void	DumpSimChannel (Stream &&out, sim::SimChannel const &simchannel, std::string indent="", bool bIndentFirst=true) const
	Dumps the content of the specified SimChannel in the output stream. 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)

Private Attributes
art::InputTag	fInputChannels
	name of SimChannel's data product More...
std::string	fOutputCategory
	name of the stream for output More...

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

Definition at line 52 of file DumpSimChannels_module.cc.

Member Typedef Documentation

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

Definition at line 55 of file DumpSimChannels_module.cc.

Constructor & Destructor Documentation

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

explicit

Configuration-checking constructor.

Definition at line 103 of file DumpSimChannels_module.cc.

  : EDAnalyzer(config)
  , fInputChannels(config().InputSimChannels())
  , fOutputCategory(config().OutputCategory())
{}

sim::DumpSimChannels::DumpSimChannels ( DumpSimChannels const &  )

delete

sim::DumpSimChannels::DumpSimChannels ( DumpSimChannels &&  )

delete

Member Function Documentation

void sim::DumpSimChannels::analyze ( art::Event const &  event )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 122 of file DumpSimChannels_module.cc.

                                                      {

  // get the particles from the event
  auto const& SimChannels
    = *(event.getValidHandle<std::vector<sim::SimChannel>>(fInputChannels));

  mf::LogVerbatim(fOutputCategory) << "Event " << event.id()
    << " : data product '" << fInputChannels.encode() << "' contains "
    << SimChannels.size() << " SimChannels";

  unsigned int iSimChannel = 0;
  for (sim::SimChannel const& simChannel: SimChannels) {

    // a bit of a header
    mf::LogVerbatim log(fOutputCategory);
    log << "[#" << (iSimChannel++) << "] ";
    DumpSimChannel(log, simChannel, "  ", false);

  } // for
  mf::LogVerbatim(fOutputCategory) << "\n";

} // sim::DumpSimChannels::analyze()

template<typename Stream >

void sim::DumpSimChannels::DumpSimChannel	(	Stream &&	out,
		sim::SimChannel const &	simchannel,
		std::string	indent = "",
		bool	bIndentFirst = true
	)		const

Dumps the content of the specified SimChannel in the output stream.

Template Parameters

Stream

the type of output stream

Parameters

out	the output stream
simchannel	the SimChannel to be dumped
indent	base indentation string (default: none)
bIndentFirst	if first output line should be indented (default: yes)

The indent string is prepended to every line of output, with the possible exception of the first one, in case bIndentFirst is true.

The output starts on the current line, and the last line is NOT broken.

Definition at line 112 of file DumpSimChannels_module.cc.

        {
  if (bIndentFirst) out << indent;
  channel.Dump(out, indent);
} // sim::DumpSimChannels::DumpSimChannels()

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

delete

DumpSimChannels& sim::DumpSimChannels::operator= ( DumpSimChannels &&  )

delete

Member Data Documentation

art::InputTag sim::DumpSimChannels::fInputChannels

private

name of SimChannel's data product

Definition at line 93 of file DumpSimChannels_module.cc.

std::string sim::DumpSimChannels::fOutputCategory

private

name of the stream for output

Definition at line 94 of file DumpSimChannels_module.cc.

---

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

• larsim/larsim/MCDumpers/DumpSimChannels_module.cc