DD4hep  1.38.0
Detector Description Toolkit for High Energy Physics
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dd4hep::cond::ConditionsDataLoader Class Referenceabstract

Interface for a generic conditions loader. More...

#include <ConditionsDataLoader.h>

Inheritance diagram for dd4hep::cond::ConditionsDataLoader:
dd4hep::NamedObject dd4hep::PropertyConfigurable dd4hep::PropertyInterface dd4hep::cond::ConditionsMultiLoader dd4hep::cond::ConditionsSnapshotRootLoader dd4hep::cond::ConditionsXmlLoader

Public Types

typedef std::pair< std::string, IOV > Source
 
typedef std::vector< Source > Sources
 
typedef ConditionsDataLoader base_t
 
typedef Condition::key_type key_type
 
typedef std::map< key_type, Condition > LoadedItems
 
typedef std::vector< std::pair< key_type, ConditionsLoadInfo * > > RequiredItems
 

Public Member Functions

 ConditionsDataLoader (Detector &description, ConditionsManager mgr, const std::string nam)
 Default constructor. More...
 
virtual ~ConditionsDataLoader ()
 Default destructor. More...
 
virtual void initialize ()
 Optional initialization for sub-classes. More...
 
ConditionsManager manager () const
 Access conditions manager. More...
 
Property & operator[] (const std::string &property_name)
 Access to properties. More...
 
const Property & operator[] (const std::string &property_name) const
 Access to properties (CONST) More...
 
void addSource (const std::string &source)
 Add data source definition to loader. More...
 
void addSource (const std::string &source, const IOV &iov)
 Add data source definition to loader for data corresponding to a given IOV. More...
 
virtual size_t load_many (const IOV &req_validity, RequiredItems &work, LoadedItems &loaded, IOV &combined_validity)=0
 Load a number of conditions items from the persistent medium according to the required IOV. More...
 
- Public Member Functions inherited from dd4hep::NamedObject
 NamedObject (const char *nam, const char *typ="")
 Initializing constructor. More...
 
 NamedObject (const std::string &nam)
 Initializing constructor. More...
 
 NamedObject (const std::string &nam, const std::string &typ)
 Initializing constructor. More...
 
 NamedObject ()=default
 Standard constructor. More...
 
 NamedObject (const NamedObject &c)=default
 Copy constructor. More...
 
 NamedObject (NamedObject &&c)=default
 Move constructor. More...
 
virtual ~NamedObject ()=default
 Default destructor. More...
 
NamedObject & operator= (const NamedObject &c)=default
 Assignment operator. More...
 
NamedObject & operator= (NamedObject &&c)=default
 Move assignment operator. More...
 
const char * GetName () const
 Access name. More...
 
void SetName (const char *nam)
 Set name (used by Handle) More...
 
void SetTitle (const char *tit)
 Set Title (used by Handle) More...
 
const char * GetTitle () const
 Get name (used by Handle) More...
 
- Public Member Functions inherited from dd4hep::PropertyConfigurable
 PropertyConfigurable ()
 Standard constructor. More...
 
virtual ~PropertyConfigurable ()
 Default destructor. More...
 
virtual PropertyManager & properties () override
 Access to the properties of the object. More...
 
virtual const PropertyManager & properties () const override
 Access to the properties of the object. More...
 
virtual bool hasProperty (const std::string &name) const override
 Check property for existence. More...
 
virtual Property & property (const std::string &name) override
 Access single property. More...
 
template<typename T >
void declareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
void declareProperty (const char *nam, T &val)
 Declare property. More...
 
- Public Member Functions inherited from dd4hep::PropertyInterface
virtual ~PropertyInterface ()=default
 Default destructor. More...
 

Protected Member Functions

void pushUpdates ()
 Queue update to manager. More...
 

Protected Attributes

Detector & m_detector
 Reference to main detector description object. More...
 
ConditionsManager m_mgr
 Reference to conditions manager used to queue update requests. More...
 
Sources m_sources
 Property: input data source definitions. More...
 
- Protected Attributes inherited from dd4hep::PropertyConfigurable
PropertyManager m_properties
 Property pool. More...
 

Additional Inherited Members

- Public Attributes inherited from dd4hep::NamedObject
std::string name
 The object name. More...
 
std::string type
 The object type. More...
 

Detailed Description

Interface for a generic conditions loader.

Common function for all loader.

Author
M.Frank
Version
1.0

Definition at line 46 of file ConditionsDataLoader.h.

Member Typedef Documentation

◆ base_t

Definition at line 50 of file ConditionsDataLoader.h.

◆ key_type

Definition at line 51 of file ConditionsDataLoader.h.

◆ LoadedItems

Definition at line 53 of file ConditionsDataLoader.h.

◆ RequiredItems

Definition at line 54 of file ConditionsDataLoader.h.

◆ Source

typedef std::pair<std::string, IOV> dd4hep::cond::ConditionsDataLoader::Source

Definition at line 48 of file ConditionsDataLoader.h.

◆ Sources

Definition at line 49 of file ConditionsDataLoader.h.

Constructor & Destructor Documentation

◆ ConditionsDataLoader()

ConditionsDataLoader::ConditionsDataLoader ( Detector &  description,
ConditionsManager  mgr,
const std::string  nam 
)

Default constructor.

Definition at line 26 of file ConditionsDataLoader.cpp.

◆ ~ConditionsDataLoader()

ConditionsDataLoader::~ConditionsDataLoader ( )
virtual

Default destructor.

Definition at line 34 of file ConditionsDataLoader.cpp.

Member Function Documentation

◆ addSource() [1/2]

void ConditionsDataLoader::addSource ( const std::string &  source)

Add data source definition to loader.

Definition at line 53 of file ConditionsDataLoader.cpp.

◆ addSource() [2/2]

void ConditionsDataLoader::addSource ( const std::string &  source,
const IOV &  iov 
)

Add data source definition to loader for data corresponding to a given IOV.

Add data source definition to loader.

Definition at line 48 of file ConditionsDataLoader.cpp.

◆ initialize()

virtual void dd4hep::cond::ConditionsDataLoader::initialize ( )
inlinevirtual

Optional initialization for sub-classes.

Definition at line 76 of file ConditionsDataLoader.h.

◆ load_many()

virtual size_t dd4hep::cond::ConditionsDataLoader::load_many ( const IOV &  req_validity,
RequiredItems &  work,
LoadedItems &  loaded,
IOV &  combined_validity 
)
pure virtual

Load a number of conditions items from the persistent medium according to the required IOV.

Implemented in dd4hep::cond::ConditionsMultiLoader, dd4hep::cond::ConditionsXmlLoader, and dd4hep::cond::ConditionsSnapshotRootLoader.

◆ manager()

ConditionsManager dd4hep::cond::ConditionsDataLoader::manager ( ) const
inline

Access conditions manager.

Definition at line 78 of file ConditionsDataLoader.h.

◆ operator[]() [1/2]

dd4hep::Property & ConditionsDataLoader::operator[] ( const std::string &  property_name)

Access to properties.

Definition at line 38 of file ConditionsDataLoader.cpp.

◆ operator[]() [2/2]

const dd4hep::Property & ConditionsDataLoader::operator[] ( const std::string &  property_name) const

Access to properties (CONST)

Definition at line 43 of file ConditionsDataLoader.cpp.

◆ pushUpdates()

void ConditionsDataLoader::pushUpdates ( )
protected

Queue update to manager.

Push update to manager.

Definition at line 63 of file ConditionsDataLoader.cpp.

Member Data Documentation

◆ m_detector

Detector& dd4hep::cond::ConditionsDataLoader::m_detector
protected

Reference to main detector description object.

Definition at line 58 of file ConditionsDataLoader.h.

◆ m_mgr

ConditionsManager dd4hep::cond::ConditionsDataLoader::m_mgr
protected

Reference to conditions manager used to queue update requests.

Definition at line 60 of file ConditionsDataLoader.h.

◆ m_sources

Sources dd4hep::cond::ConditionsDataLoader::m_sources
protected

Property: input data source definitions.

Definition at line 62 of file ConditionsDataLoader.h.


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