geo::DumpGeometry Class Reference

Describes on screen the current geometry. More...

Inheritance diagram for geo::DumpGeometry:

Classes
struct	Config

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >

Public Member Functions
	DumpGeometry (Parameters const &config)
	DumpGeometry (DumpGeometry const &)=delete
	DumpGeometry (DumpGeometry &&)=delete
DumpGeometry &	operator= (DumpGeometry const &)=delete
DumpGeometry &	operator= (DumpGeometry &&)=delete
virtual void	analyze (art::Event const &) override
virtual void	beginJob () override
	Dumps the geometry at once. More...
virtual void	beginRun (art::Run const &run) override
	Dumps the geometry if changed from the previous run. More...

Private Member Functions
template<typename Stream >
void	dumpGeometryCore (Stream &&out, geo::GeometryCore const &geom) const
	Dumps the specified geometry into the specified output stream. More...
template<typename Stream >
void	dump (Stream &&out, geo::GeometryCore const &geom)
	Dumps the geometry and records it. More...
bool	shouldDumpGeometry (geo::GeometryCore const &geom) const
	Returns whether the specified geometry should be dumped. More...

Private Attributes
std::string	fOutputCategory
	Name of the category for output. More...
std::string	fLastDetectorName
	Name of the last geometry dumped. More...

Detailed Description

Describes on screen the current geometry.

---

One print is performed at the beginning of each run.

Configuration parameters

• OutputCategory (string, default: DumpGeometry): output category used by the message facility to output information (INFO level)

Definition at line 44 of file DumpGeometry_module.cc.

Member Typedef Documentation

using geo::DumpGeometry::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 60 of file DumpGeometry_module.cc.

Constructor & Destructor Documentation

geo::DumpGeometry::DumpGeometry ( Parameters const &  config )

explicit

Definition at line 103 of file DumpGeometry_module.cc.

  : EDAnalyzer(config)
  , fOutputCategory(config().outputCategory())
  {}

geo::DumpGeometry::DumpGeometry ( DumpGeometry const &  )

delete

geo::DumpGeometry::DumpGeometry ( DumpGeometry &&  )

delete

Member Function Documentation

virtual void geo::DumpGeometry::analyze ( art::Event const &  )

inlineoverridevirtual

Definition at line 71 of file DumpGeometry_module.cc.

{}

void geo::DumpGeometry::beginJob ( )

overridevirtual

Dumps the geometry at once.

Definition at line 110 of file DumpGeometry_module.cc.

                               {

  auto const& geom = *(lar::providerFrom<geo::Geometry>());
  dump(mf::LogVerbatim(fOutputCategory), geom);

} // geo::DumpGeometry::beginJob()

void geo::DumpGeometry::beginRun ( art::Run const &  run )

overridevirtual

Dumps the geometry if changed from the previous run.

Definition at line 119 of file DumpGeometry_module.cc.

                                                {

  auto const& geom = *(lar::providerFrom<geo::Geometry>());
  if (shouldDumpGeometry(geom)) {
    mf::LogVerbatim log(fOutputCategory);
    log << "\nGeometry used in " << run.id() << ":\n";
    dump(log, geom);
  }

} // geo::DumpGeometry::beginRun()

template<typename Stream >

void geo::DumpGeometry::dump ( Stream &&  out, geo::GeometryCore const &  geom  )

private

Dumps the geometry and records it.

Definition at line 145 of file DumpGeometry_module.cc.

                                                                    {

  fLastDetectorName = geom.DetectorName();
  dumpGeometryCore(std::forward<Stream>(out), geom);

} // geo::DumpGeometry::dump()

template<typename Stream >

void geo::DumpGeometry::dumpGeometryCore ( Stream &&  out, geo::GeometryCore const &  geom  ) const

private

Dumps the specified geometry into the specified output stream.

Definition at line 134 of file DumpGeometry_module.cc.

{

  out << "Detector description: '" << geom.ROOTFile() << "'\n";
  geom.Print(std::forward<Stream>(out));

} // geo::DumpGeometry::dumpGeometryCore()

DumpGeometry& geo::DumpGeometry::operator= ( DumpGeometry const &  )

delete

DumpGeometry& geo::DumpGeometry::operator= ( DumpGeometry &&  )

delete

bool geo::DumpGeometry::shouldDumpGeometry ( geo::GeometryCore const &  geom ) const

private

Returns whether the specified geometry should be dumped.

Definition at line 154 of file DumpGeometry_module.cc.

{

  // only dump if not already dumped
  return geom.DetectorName() != fLastDetectorName;

} // geo::DumpGeometry::shouldDumpGeometry()

Member Data Documentation

std::string geo::DumpGeometry::fLastDetectorName

private

Name of the last geometry dumped.

Definition at line 82 of file DumpGeometry_module.cc.

std::string geo::DumpGeometry::fOutputCategory

private

Name of the category for output.

Definition at line 81 of file DumpGeometry_module.cc.

---

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

• DumpGeometry_module.cc