Base class for all providers of conditions objects. More...

#include <ConditionsObjectProvider.h>

Public Member Functions
	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 std::pair< const ConditionsObject *, ConditionsIOV >	getCondition (const ldmx::EventHeader &context)=0
	Pure virtual getCondition function.

virtual void	releaseConditionsObject (const ConditionsObject *co)
	Called by conditions system when done with a conditions object, appropriate point for cleanup.

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.

virtual void	onNewRun (ldmx::RunHeader &)
	Callback for the ConditionsObjectProvider to take any necessary action when the processing of events starts for a given run.

const std::string &	getConditionObjectName () const
	Get the list of conditions objects available from this provider.

const std::string &	getTagName () const
	Access the tag name.

Protected Member Functions
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
logging::logger	the_log_
	The logger for this ConditionsObjectProvider.

Private Attributes
Process &	process_
	Handle to the Process.

std::string	object_name_
	The name of the object provided by this provider.

std::string	tagname_
	The tag name for the ConditionsObjectProvider.

Detailed Description

Base class for all providers of conditions objects.

Definition at line 44 of file ConditionsObjectProvider.h.

Constructor & Destructor Documentation

◆ ConditionsObjectProvider()

ConditionsObjectProvider::ConditionsObjectProvider	(	const std::string &	objname,
		const std::string &	tagname,
		const framework::config::Parameters &	parameters,
		Process &	process )

Class constructor.

Parameters

name	Name for this instance of the class.
tagName	The tag for the database entry (should not include whitespace)
process	The Process class associated with ConditionsObjectProvider, provided by the framework.

Note: The name provided to this function should not be the class name, but rather a logical label for this instance of the class, as more than one copy of a given class can be loaded into a Process with different parameters. Names should not include whitespace or special characters.

Definition at line 8 of file ConditionsObjectProvider.cxx.

    : the_log_{logging::makeLogger(objname)},
      process_{process},
      object_name_{objname},
      tagname_{tagname} {}

Member Function Documentation

◆ getCondition()

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

pure virtual

Pure virtual getCondition function.

Must be implemented by any Conditions providers.

Implemented in conditions::SimpleCSVTableProvider, ecal::EcalDetectorMapLoader, ecal::EcalGeometryProvider, ecal::EcalTriggerGeometryProvider, framework::RandomNumberSeedService, hcal::HcalDetectorMapLoader, hcal::HcalGeometryProvider, hcal::HcalReconConditionsProvider, hcal::HcalTriggerGeometryProvider, tracking::geo::CalibrationContextProvider, tracking::geo::GeometryContextProvider, tracking::geo::MagneticFieldContextProvider, and tracking::geo::TrackersTrackingGeometryProvider.

◆ getConditionObjectName()

const std::string & framework::ConditionsObjectProvider::getConditionObjectName ( ) const

inline

Get the list of conditions objects available from this provider.

Definition at line 114 of file ConditionsObjectProvider.h.

114{ return object_name_; }

References object_name_.

◆ getTagName()

const std::string & framework::ConditionsObjectProvider::getTagName ( ) const

inline

Access the tag name.

Definition at line 119 of file ConditionsObjectProvider.h.

119{ return tagname_; }

References tagname_.

◆ onNewRun()

virtual void framework::ConditionsObjectProvider::onNewRun ( ldmx::RunHeader & )

inlinevirtual

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

Reimplemented in ecal::EcalGeometryProvider, framework::RandomNumberSeedService, and hcal::HcalGeometryProvider.

Definition at line 109 of file ConditionsObjectProvider.h.

109{}

◆ onProcessEnd()

virtual void framework::ConditionsObjectProvider::onProcessEnd ( )

inlinevirtual

Callback for the ConditionsObjectProvider to take any necessary action when the processing of events finishes, such as closing database connections.

Definition at line 103 of file ConditionsObjectProvider.h.

103{}

◆ onProcessStart()

virtual void framework::ConditionsObjectProvider::onProcessStart ( )

inlinevirtual

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

Definition at line 96 of file ConditionsObjectProvider.h.

96{}

◆ process()

const Process & framework::ConditionsObjectProvider::process ( ) const

inlineprotected

Get the process handle.

Definition at line 130 of file ConditionsObjectProvider.h.

130{ return process_; }

References process_.

Referenced by framework::RandomNumberSeedService::onNewRun().

◆ releaseConditionsObject()

virtual void framework::ConditionsObjectProvider::releaseConditionsObject ( const ConditionsObject * co )

inlinevirtual

Called by conditions system when done with a conditions object, appropriate point for cleanup.

Note: Default behavior is to delete the object!

Reimplemented in ecal::EcalDetectorMapLoader, ecal::EcalGeometryProvider, ecal::EcalTriggerGeometryProvider, framework::RandomNumberSeedService, hcal::HcalDetectorMapLoader, hcal::HcalGeometryProvider, and hcal::HcalTriggerGeometryProvider.

Definition at line 88 of file ConditionsObjectProvider.h.

                                                                   {
    delete co;
  }

◆ requestParentCondition()

std::pair< const ConditionsObject *, ConditionsIOV > ConditionsObjectProvider::requestParentCondition	(	const std::string &	name,
		const ldmx::EventHeader &	context )

protected

Request another condition needed to construct this condition.

Definition at line 17 of file ConditionsObjectProvider.cxx.

                                                           {
  const ConditionsObject* obj = process_.getConditions().getConditionPtr(name);
  ConditionsIOV iov = process_.getConditions().getConditionIOV(name);
  return std::make_pair(obj, iov);
}