hcal::HcalGeometryProvider Class Reference

Public Member Functions
	HcalGeometryProvider (const std::string &name, const std::string &tagname, const framework::config::Parameters &parameters, framework::Process &process)
	Class constructor.
virtual	~HcalGeometryProvider ()
	Destructor.
virtual std::pair< const framework::ConditionsObject *, framework::ConditionsIOV >	getCondition (const ldmx::EventHeader &context)
	Provides access to the HcalGeometry.
virtual void	releaseConditionsObject (const framework::ConditionsObject *co)
	Take no action on release, as the object is permanently owned by the Provider.
virtual void	onNewRun (ldmx::RunHeader &rh)
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts for a given run.
Public Member Functions inherited from framework::ConditionsObjectProvider
	DECLARE_FACTORY (ConditionsObjectProvider, std::shared_ptr< ConditionsObjectProvider >, const std::string &, const std::string &, const framework::config::Parameters &, Process &)
	declare that we have a factory for these types of classes
	ConditionsObjectProvider (const std::string &objname, const std::string &tagname, const framework::config::Parameters &parameters, Process &process)
	Class constructor.
virtual	~ConditionsObjectProvider ()=default
	Class destructor.
virtual void	onProcessStart ()
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts.
virtual void	onProcessEnd ()
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events finishes, such as closing database connections.
const std::string &	getConditionObjectName () const
	Get the list of conditions objects available from this provider.
const std::string &	getTagName () const
	Access the tag name.

Private Attributes
framework::config::Parameters	params_
	Handle to the parameters, needed for future use during get condition.
std::string	detector_geometry_
	Geometry as last used.
ldmx::HcalGeometry *	hcal_geometry_

Additional Inherited Members
Protected Member Functions inherited from framework::ConditionsObjectProvider
std::pair< const ConditionsObject *, ConditionsIOV >	requestParentCondition (const std::string &name, const ldmx::EventHeader &context)
	Request another condition needed to construct this condition.
const Process &	process () const
	Get the process handle.
Protected Attributes inherited from framework::ConditionsObjectProvider
logging::logger	the_log_
	The logger for this ConditionsObjectProvider.

Detailed Description

Definition at line 18 of file HcalGeometryProvider.cxx.

Constructor & Destructor Documentation

HcalGeometryProvider()

hcal::HcalGeometryProvider::HcalGeometryProvider	(	const std::string &	name,
		const std::string &	tagname,
		const framework::config::Parameters &	parameters,
		framework::Process &	process )

Class constructor.

Parameters

parameters

– uses the "HcalGeometry" section to configure the HcalGeometry

Definition at line 73 of file HcalGeometryProvider.cxx.

    : framework::
          ConditionsObjectProvider{ldmx::HcalGeometry::CONDITIONS_OBJECT_NAME,
                                   tagname, parameters, process},
      params_{parameters} {
  hcal_geometry_ = 0;
}

~HcalGeometryProvider()

hcal::HcalGeometryProvider::~HcalGeometryProvider ( )

virtual

Destructor.

Definition at line 84 of file HcalGeometryProvider.cxx.

                                            {
  if (hcal_geometry_) delete hcal_geometry_;
  hcal_geometry_ = 0;
}

Member Function Documentation

getCondition()

std::pair< const framework::ConditionsObject *, framework::ConditionsIOV > hcal::HcalGeometryProvider::getCondition ( const ldmx::EventHeader & context )

virtual

Provides access to the HcalGeometry.

Note

Currently, these are assumed to be valid for all time, but this behavior could be changed. Users should not cache the pointer between events

Implements framework::ConditionsObjectProvider.

Definition at line 90 of file HcalGeometryProvider.cxx.

                                                                 {
  static const std::string keyname("detectors_valid");
 
  if (!hcal_geometry_) {
    framework::config::Parameters phex =
        (params_.exists("HcalGeometry"))
            ? (params_.get<framework::config::Parameters>("HcalGeometry"))
            : (params_);
 
    // search through the subtrees
    for (auto key : phex.keys()) {
      framework::config::Parameters pver =
          phex.get<framework::config::Parameters>(key);
 
      if (!pver.exists(keyname)) {
        ldmx_log(warn) << "No parameter " << keyname << " found in " << key;
        // log strange situation and continue
        continue;
      }
 
      std::vector<std::string> dets_valid =
          pver.get<std::vector<std::string> >(keyname);
      for (auto detregex : dets_valid) {
        std::string regex(detregex);
        if (regex.empty()) continue;  // no empty regex allowed
        if (regex[0] != '^') regex.insert(0, 1, '^');
        if (regex.back() != '$') regex += '$';
        regex_t reg;
 
        int rv =
            regcomp(&reg, regex.c_str(), REG_EXTENDED | REG_ICASE | REG_NOSUB);
        if (rv) {
          char err[1024];
          regerror(rv, &reg, err, 1024);
          EXCEPTION_RAISE(
              "GeometryException",
              "Invalid detector regular expression : '" + regex + "' " + err);
        }
        int nmatch = regexec(&reg, detector_geometry_.c_str(), 0, 0, 0);
        regfree(&reg);
        if (!nmatch) {
          hcal_geometry_ = new ldmx::HcalGeometry(pver);
          break;
        }
      }
      if (hcal_geometry_) break;
    }
    if (!hcal_geometry_) {
      EXCEPTION_RAISE("GeometryException", "Unable to create HcalGeometry");
    }
  }
 
  return std::make_pair(
      hcal_geometry_,
      framework::ConditionsIOV(context.getRun(), context.getRun(), true, true));
}

References detector_geometry_, framework::config::Parameters::exists(), framework::config::Parameters::get(), ldmx::EventHeader::getRun(), framework::config::Parameters::keys(), and params_.

onNewRun()

virtual void hcal::HcalGeometryProvider::onNewRun ( ldmx::RunHeader & )

inlinevirtual

Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts for a given run.

Reimplemented from framework::ConditionsObjectProvider.

Definition at line 48 of file HcalGeometryProvider.cxx.

                                           {
    if (detector_geometry_.empty())
      detector_geometry_ = rh.getDetectorName();
    else if (hcal_geometry_ != nullptr &&
             detector_geometry_ != rh.getDetectorName()) {
      EXCEPTION_RAISE(
          "GeometryException",
          "Attempting to run a single job with multiple geometries " +
              detector_geometry_ + " and '" + rh.getDetectorName() + "'");
    }
    // make sure detector name has been set
    if (detector_geometry_.empty())
      EXCEPTION_RAISE("GeometryException",
                      "HcalGeometryProvider unable to get the name of the "
                      "detector from the RunHeader.");
  }

References detector_geometry_, and ldmx::RunHeader::getDetectorName().

releaseConditionsObject()

virtual void hcal::HcalGeometryProvider::releaseConditionsObject ( const framework::ConditionsObject * co )

inlinevirtual

Take no action on release, as the object is permanently owned by the Provider.

Reimplemented from framework::ConditionsObjectProvider.

Definition at line 46 of file HcalGeometryProvider.cxx.

{}

Member Data Documentation

detector_geometry_

std::string hcal::HcalGeometryProvider::detector_geometry_

private

Geometry as last used.

Definition at line 69 of file HcalGeometryProvider.cxx.

Referenced by getCondition(), and onNewRun().

hcal_geometry_

ldmx::HcalGeometry* hcal::HcalGeometryProvider::hcal_geometry_

private

Definition at line 70 of file HcalGeometryProvider.cxx.

params_

framework::config::Parameters hcal::HcalGeometryProvider::params_

private

Handle to the parameters, needed for future use during get condition.

Definition at line 67 of file HcalGeometryProvider.cxx.

Referenced by getCondition().

---

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

• Hcal/src/Hcal/HcalGeometryProvider.cxx