framework::Conditions Class Reference

Container and cache for conditions and conditions providers. More...

#include <Conditions.h>

Classes
struct	CacheEntry
	An entry to store an already loaded conditions object. More...

Public Member Functions
	Conditions (Process &)
	Constructor.
	~Conditions ()
	Class destructor.
const ConditionsObject *	getConditionPtr (const std::string &condition_name)
	Primary request action for a conditions object If the object is in the cache and still valid (IOV), the cached object will be returned.
template<class T >
const T &	getCondition (const std::string &condition_name)
	Primary request action for a conditions object If the object is in the cache and still valid (IOV), the cached object will be returned.
ConditionsIOV	getConditionIOV (const std::string &condition_name) const
	Access the IOV for the given condition.
void	onProcessStart ()
	Calls onProcessStart for all ConditionsObjectProviders.
void	onProcessEnd ()
	Calls onProcessEnd for all ConditionsObjectProviders.
void	onNewRun (ldmx::RunHeader &)
	Calls onNewRun for all ConditionsObjectProviders.
void	createConditionsObjectProvider (const std::string &classname, const std::string &instancename, const std::string &tagname, const framework::config::Parameters &params)
	Create a ConditionsObjectProvider given the information.

Private Attributes
Process &	process_
	Handle to the Process.
std::map< std::string, std::shared_ptr< ConditionsObjectProvider > >	provider_map_
	Map of who provides which condition.
std::map< std::string, CacheEntry >	cache_
	Conditions cache.

Detailed Description

Container and cache for conditions and conditions providers.

Definition at line 43 of file Conditions.h.

Constructor & Destructor Documentation

Conditions()

framework::Conditions::Conditions

(

Process &

p

)

Constructor.

Definition at line 10 of file Conditions.cxx.

: process_{p} {}

~Conditions()

framework::Conditions::~Conditions

(

)

Class destructor.

Releases all cached conditions objects via their providers.

Definition at line 12 of file Conditions.cxx.

                        {
  for (auto& [name, entry] : cache_) {
    if (entry.obj_ && entry.provider_) {
      entry.provider_->releaseConditionsObject(entry.obj_);
      entry.obj_ = nullptr;
    }
  }
}

References cache_.

Member Function Documentation

createConditionsObjectProvider()

void framework::Conditions::createConditionsObjectProvider	(	const std::string &	classname,
		const std::string &	instancename,
		const std::string &	tagname,
		const framework::config::Parameters &	params )

Create a ConditionsObjectProvider given the information.

Definition at line 21 of file Conditions.cxx.

                                                                       {
  auto cop = ConditionsObjectProvider::Factory::get().make(
      classname, objname, tagname, params, process_);
  if (not cop) {
    EXCEPTION_RAISE("UnableToCreate",
                    "No ConditionsObjectProvider for " + classname);
  }
 
  std::string provides = cop.value()->getConditionObjectName();
  if (provider_map_.find(provides) != provider_map_.end()) {
    EXCEPTION_RAISE(
        "ConditionAmbiguityException",
        "Multiple ConditonsObjectProviders configured to provide " + provides);
  }
  provider_map_[provides] = cop.value();
}

References process_, and provider_map_.

Referenced by framework::Process::Process().

getCondition()

template<class T >

const T & framework::Conditions::getCondition ( const std::string & condition_name )

inline

Primary request action for a conditions object If the object is in the cache and still valid (IOV), the cached object will be returned.

If it is not in the cache, or is out of date, the ConditionsObjectProvider::getCondition method will be called to provide the object.

See also

getConditionPtr

Template Parameters

T	type to cast condition object to

Parameters

[in]

condition_name

name of condition to retrieve

Returns

const reference to conditions object

Definition at line 85 of file Conditions.h.

                                                         {
    return dynamic_cast<const T&>(*getConditionPtr(condition_name));
  }

References getConditionPtr().

Referenced by framework::EventProcessor::getCondition().

getConditionIOV()

ConditionsIOV framework::Conditions::getConditionIOV

(

const std::string &

condition_name

)

const

Access the IOV for the given condition.

Parameters

[in]

condition_name

name of condition to get IOV for

Returns

Interval Of Validity for the input condition name

Definition at line 52 of file Conditions.cxx.

                                           {
  auto cacheptr = cache_.find(condition_name);
  if (cacheptr == cache_.end()) {
    return ConditionsIOV();
  } else {
    return cacheptr->second.iov_;
  }
}

References cache_.

Referenced by framework::ConditionsObjectProvider::requestParentCondition().

getConditionPtr()

const ConditionsObject * framework::Conditions::getConditionPtr

(

const std::string &

condition_name

)

Primary request action for a conditions object If the object is in the cache and still valid (IOV), the cached object will be returned.

If it is not in the cache, or is out of date, the ConditionsObjectProvider::getCondition method will be called to provide the object.

Exceptions

Exception

if condition object or provider for that object is not found.

Parameters

[in]

condition_name

name of condition to retrieve

Returns

pointer to conditions object with input name

Definition at line 62 of file Conditions.cxx.

                                     {
  const ldmx::EventHeader& context = *(process_.getEventHeader());
  auto cacheptr = cache_.find(condition_name);
 
  if (cacheptr == cache_.end()) {
    auto copptr = provider_map_.find(condition_name);
 
    if (copptr == provider_map_.end()) {
      EXCEPTION_RAISE("ConditionUnavailable",
                      "No provider is available for : " + condition_name);
    }
 
    std::pair<const ConditionsObject*, ConditionsIOV> cond =
        copptr->second->getCondition(context);
 
    if (!cond.first) {
      EXCEPTION_RAISE(
          "ConditionUnavailable",
          "Null condition returned for requested item : " + condition_name);
    }
 
    // first request, create a cache entry
    CacheEntry ce;
    ce.iov_ = cond.second;
    ce.obj_ = cond.first;
    ce.provider_ = copptr->second;
    cache_[condition_name] = ce;
    return ce.obj_;
  } else {
    // if still valid, we return what we have
    if (cacheptr->second.iov_.validForEvent(context)) {
      return cacheptr->second.obj_;
    } else {
      // if not, we release the old object
      cacheptr->second.provider_->releaseConditionsObject(
          cacheptr->second.obj_);
      cacheptr->second.obj_ = nullptr;
      // now ask for a new one
      std::pair<const ConditionsObject*, ConditionsIOV> cond =
          cacheptr->second.provider_->getCondition(context);
 
      if (!cond.first) {
        std::stringstream s;
        s << "Unable to update condition '" << condition_name << "' for event "
          << context.getEventNumber() << " run " << context.getRun();
        if (context.isRealData()) {
          s << " DATA";
        } else {
          s << " MC";
        }
        EXCEPTION_RAISE("ConditionUnavailable", s.str());
      }
      cacheptr->second.iov_ = cond.second;
      cacheptr->second.obj_ = cond.first;
      return cond.first;
    }
  }
}

References cache_, framework::Process::getEventHeader(), ldmx::EventHeader::getEventNumber(), ldmx::EventHeader::getRun(), framework::Conditions::CacheEntry::iov_, ldmx::EventHeader::isRealData(), framework::Conditions::CacheEntry::obj_, process_, framework::Conditions::CacheEntry::provider_, and provider_map_.

Referenced by getCondition(), and framework::ConditionsObjectProvider::requestParentCondition().

onNewRun()

void framework::Conditions::onNewRun

(

ldmx::RunHeader &

rh

)

Calls onNewRun for all ConditionsObjectProviders.

Definition at line 48 of file Conditions.cxx.

                                           {
  for (auto ptr : provider_map_) ptr.second->onNewRun(rh);
}

References provider_map_.

Referenced by framework::Process::newRun().

onProcessEnd()

void framework::Conditions::onProcessEnd

(

)

Calls onProcessEnd for all ConditionsObjectProviders.

Definition at line 44 of file Conditions.cxx.

                              {
  for (auto ptr : provider_map_) ptr.second->onProcessEnd();
}

References provider_map_.

onProcessStart()

void framework::Conditions::onProcessStart

(

)

Calls onProcessStart for all ConditionsObjectProviders.

Definition at line 40 of file Conditions.cxx.

                                {
  for (auto ptr : provider_map_) ptr.second->onProcessStart();
}

References provider_map_.

Referenced by framework::Process::run().

Member Data Documentation

cache_

std::map<std::string, CacheEntry> framework::Conditions::cache_

private

Conditions cache.

Definition at line 140 of file Conditions.h.

Referenced by getConditionIOV(), getConditionPtr(), and ~Conditions().

process_

Process& framework::Conditions::process_

private

Handle to the Process.

Definition at line 121 of file Conditions.h.

Referenced by createConditionsObjectProvider(), and getConditionPtr().

provider_map_

std::map<std::string, std::shared_ptr<ConditionsObjectProvider> > framework::Conditions::provider_map_

private

Map of who provides which condition.

Definition at line 125 of file Conditions.h.

Referenced by createConditionsObjectProvider(), getConditionPtr(), onNewRun(), onProcessEnd(), and onProcessStart().

---

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

• Framework/include/Framework/Conditions.h
• Framework/src/Framework/Conditions.cxx