Class to access a DB Array from Python. More...

#include <PyDBArray.h>

Inheritance diagram for PyDBArray:

Public Member Functions
	PyDBArray (const std::string &name, bool required=true)
	Construct the array from the name of the payload.

	PyDBArray (const TClass *objClass, bool required=true)
	Construct the array from the type of the payload, payload name will be the class name.

	PyDBArray (const std::string &name, const TClass *objClass, bool required=true)
	Construct the array from the name of the payload and make sure the class if compatible with objClass.

int	getEntries () const
	Get the number of entries.

int	__len__ () const
	Get the number of entries in a pythonic way to enable len(array)

const TObject *	_get (int i) const
	Element access.

PyObject *	getIntraRunBoundariesList () const
	Get the intra-run boundaries, if any, as a python list.

bool	isValid () const
	Check whether a valid object was obtained from the database.

bool	hasChanged ()
	Check whether the object has changed since the last call to hasChanged of the accessor).

Private Member Functions
const std::string &	getName () const
	Return name under which the object is saved in the DBStore.

	operator bool () const
	Imitate pointer functionality.

virtual bool	operator== (const DBAccessorBase &other) const
	Check if two store accessors point to the same object/array.

virtual bool	operator!= (const DBAccessorBase &other) const
	Check if two store accessors point to a different object/array.

void	addCallback (std::function< void(const std::string &)> callback, bool onDestruction=false)
	Add a callback method.

void	addCallback (std::function< void()> callback, bool onDestruction=false)
	Add a callback method.

template<class T >
void	addCallback (T object, void(T::callback)())
	Add a callback method of an object.

const std::string &	getGlobaltag () const
	Return the globaltag name (or testing payloads path) this object is loaded from.

unsigned int	getRevision () const
	Return current revision of the object.

IntervalOfValidity	getIoV () const
	Return current IoV of the object.

const std::string &	getChecksum () const
	Get current checksum.

const std::string &	getFilename () const
	Get the filename this object is loaded from.

bool	isIntraRunDependent () const
	Check wether this conditions object has some intra-run dependencies.

const std::vector< unsigned int >	getIntraRunBoundaries () const
	Get the intra-run boundaries, if any.

bool	isRequired () const
	Check whether this conditions object is required (at least one user declared it as required)

template<class T = TObject>
const T *	getObject () const
	Return a pointer to the Object already cast to the correct type.

bool	ensureAttached () const
	Make sure we are attached to the the DBStore.

void	storeEntryChanged (bool destructed)
	Callback function which gets called by the DBStoreEntry object if it changes.

Private Attributes
const DBStoreEntry::EPayloadType	m_type
	Type of the payload.

const std::string	m_name
	Name of the payload in the database.

const TClass *	m_objClass
	Class of the payload if type is c_Object.

const bool	m_isArray
	True if the payload is an array of objects.

const bool	m_isRequired
	True if the payload is required, otherwise no errors will be raised if it cannot be found.

DBStoreEntry *	m_entry
	Pointer to the entry in the DBStore.

bool	m_changed {false}
	Internal flag whether the object has changed since we last checked.

std::vector< std::pair< std::function< void(const std::string &)>, bool > >	m_callbacks
	List of all registered callback functions.

Detailed Description

Class to access a DB Array from Python.

In contrast to the C++ DBArray we don't have templates but python will handle the typing dynamically.

from ROOT import Belle2
bklmmapping = Belle2.PyDBArray('BKLMElectronicMapping')
# Alternative: simhits = Belle2.PyDBArray(Belle2.BKLMElectronicMapping.Class())
# Or with name and type: beamparams = Belle2.PyDBArray("BKLMElectronicMapping, Belle2.BKLMElectronicMapping.Class())
for mapping in bklmmapping:
    print(mapping.getCopperId())

Warning: Be aware that PyDBArray objects are only usable during event flow, that is in the initialize() or event() calls of a module as there is no Conditions data available otherwise.

See also: the object version PyDBObj as well as the interface classes to the DataStore, PyStoreArray and PyStoreObj

Definition at line 43 of file PyDBArray.h.

Constructor & Destructor Documentation

◆ PyDBArray() [1/3]

PyDBArray	(	const std::string &	name,
		bool	required = `true`
	)

explicit

Construct the array from the name of the payload.

Definition at line 44 of file PyDBArray.cc.

44: PyDBArray(name, getDefaultClass(name), required) {}

◆ PyDBArray() [2/3]

PyDBArray	(	const TClass *	objClass,
		bool	required = `true`
	)

explicit

Construct the array from the type of the payload, payload name will be the class name.

Definition at line 46 of file PyDBArray.cc.

46: PyDBArray(DataStore::defaultArrayName(objClass), objClass, required) {}

Belle2::DataStore::defaultArrayName

static std::string defaultArrayName()

Return the default storage name for an array of the given type.

Definition: DataStore.h:157

◆ PyDBArray() [3/3]

PyDBArray	(	const std::string &	name,
		const TClass *	objClass,
		bool	required = `true`
	)

explicit

Construct the array from the name of the payload and make sure the class if compatible with objClass.

Definition at line 48 of file PyDBArray.cc.

48 : DBAccessorBase(name, objClass, true,

49 required) {}

Belle2::DBAccessorBase

Base class for DBObjPtr and DBArray for easier common treatment.

Definition: DBAccessorBase.h:26

Member Function Documentation

◆ len()

int __len__ ( ) const

inline

Get the number of entries in a pythonic way to enable len(array)

Definition at line 61 of file PyDBArray.h.

61{ return getEntries(); }

Belle2::PyDBArray::getEntries

int getEntries() const

Get the number of entries.

Definition: PyDBArray.cc:39

◆ _get()

const TObject * _get ( int i ) const

Element access.

Sadly the const in the return value is lost in python so this is a protected method and we add a pure python method to wrap the object in something to guarantee constness in framework/scripts/basf2.py

Definition at line 34 of file PyDBArray.cc.

{
  return getObject<TClonesArray>()->At(i);
}

◆ addCallback() [1/3]

void addCallback	(	std::function< void()>	callback,
		bool	onDestruction = `false`
	)

inlineinherited

Add a callback method.

The given method will be called whenever there is a new database entry for this DBAccessor.

Parameters

callback	function pointer to a callback function
onDestruction	if true the callback will not be called for each change but only when the Database entry is deleted and can be used to remove dangling pointers to the entry.

Definition at line 118 of file DBAccessorBase.h.

    {
      addCallback([callback](const std::string&) -> void { callback(); }, onDestruction);
    }

◆ addCallback() [2/3]

void addCallback	(	std::function< void(const std::string &)>	callback,
		bool	onDestruction = `false`
	)

inlineinherited

Add a callback method.

The given method will be called whenever there is a new database entry for this DBAccessor. The one parameter is the name of the DB entry which changed (in case the same callback method is to be used for multiple payloads.

Parameters

callback	function pointer to a callback function
onDestruction	if true the callback will not be called for each change but only when the Database entry is deleted and can be used to remove dangling pointers to the entry.

Definition at line 105 of file DBAccessorBase.h.

    {
      m_callbacks.emplace_back(callback, onDestruction);
    }

◆ addCallback() [3/3]

void addCallback	(	T *	object,
		void(T::*)()	callback
	)

inlineinherited

Add a callback method of an object.

The given method will be called whenever there is a new database entry for this DBAccessor.

Parameters

object	The object with the callback method.
callback	The callback method.

Definition at line 130 of file DBAccessorBase.h.

    {
      addCallback([ = ](const std::string&) {(*object.*callback)();});
    }

◆ ensureAttached()

bool ensureAttached ( ) const

inlineprotectedinherited

Make sure we are attached to the the DBStore.

If not try to reconnect

Definition at line 171 of file DBAccessorBase.h.

    {
      if (!m_entry) {
        B2DEBUG(32, "DBAccessor " << m_name << " lost connection, reattaching");
        m_entry = DBStore::Instance().getEntry(m_type, m_name, m_objClass, m_isArray, m_isRequired);
        m_changed = true;
        if (!m_entry) return false;
        m_entry->registerAccessor(const_cast<DBAccessorBase*>(this));
      }
      return true;
    }

◆ getChecksum()

const std::string & getChecksum ( ) const

inlineinherited

Get current checksum.

Definition at line 145 of file DBAccessorBase.h.

145{ ensureAttached(); return m_entry->getChecksum(); }

Belle2::DBAccessorBase::ensureAttached

bool ensureAttached() const

Make sure we are attached to the the DBStore.

Definition: DBAccessorBase.h:171

Belle2::DBStoreEntry::getChecksum

const std::string & getChecksum() const

get the checksum of the payload.

Definition: DBStoreEntry.h:104

◆ getEntries()

int getEntries ( ) const

Get the number of entries.

Definition at line 39 of file PyDBArray.cc.

{
  return isValid() ? (getObject<TClonesArray>()->GetEntriesFast()) : 0;
}

◆ getFilename()

const std::string & getFilename ( ) const

inlineinherited

Get the filename this object is loaded from.

Definition at line 148 of file DBAccessorBase.h.

148{ ensureAttached(); return m_entry->getFilename(); }

Belle2::DBStoreEntry::getFilename

const std::string & getFilename() const

get the filename for this payload

Definition: DBStoreEntry.h:101

◆ getGlobaltag()

const std::string & getGlobaltag ( ) const

inlineinherited

Return the globaltag name (or testing payloads path) this object is loaded from.

Definition at line 136 of file DBAccessorBase.h.

136{ ensureAttached(); return m_entry->getGlobaltag(); }

Belle2::DBStoreEntry::getGlobaltag

const std::string & getGlobaltag() const

get the globaltag name (or testing payloads path) from which the payload is picked.

Definition: DBStoreEntry.h:94

◆ getIntraRunBoundaries()

const std::vector< unsigned int > getIntraRunBoundaries ( ) const

inlineinherited

Get the intra-run boundaries, if any.

If the intra-run dependency is by event number, the event numbers used as boundaries are returned.

Definition at line 157 of file DBAccessorBase.h.

157{ ensureAttached(); return m_entry->getIntraRunBoundaries(); }

Belle2::DBStoreEntry::getIntraRunBoundaries

const std::vector< unsigned int > getIntraRunBoundaries() const

return the boundaries of the intra-run changes of the payload, if any

Definition: DBStoreEntry.h:121

◆ getIntraRunBoundariesList()

PyObject * getIntraRunBoundariesList ( ) const

Get the intra-run boundaries, if any, as a python list.

Definition at line 51 of file PyDBArray.cc.

{
  PyObject* list = PyList_New(0);
  // Currently, the boundaries are defined only as unsigned int.
  // If in the future this will change, this method has to be updated accordingly.
  for (auto boundary : getIntraRunBoundaries())
    PyList_Append(list, PyLong_FromUnsignedLong(boundary));
  return list;
}

◆ getIoV()

IntervalOfValidity getIoV ( ) const

inlineinherited

Return current IoV of the object.

Definition at line 142 of file DBAccessorBase.h.

142{ ensureAttached(); return m_entry->getIoV(); }

Belle2::DBStoreEntry::getIoV

IntervalOfValidity getIoV() const

get the validity of the payload

Definition: DBStoreEntry.h:99

◆ getName()

const std::string & getName ( ) const

inlineinherited

Return name under which the object is saved in the DBStore.

Definition at line 66 of file DBAccessorBase.h.

66{ return m_name; }

◆ getObject()

const T * getObject ( ) const

inlineprotectedinherited

Return a pointer to the Object already cast to the correct type.

Definition at line 164 of file DBAccessorBase.h.

    {
      if (!ensureAttached()) return nullptr;
      return reinterpret_cast<const T*>(m_entry->getObject());
    }

◆ getRevision()

unsigned int getRevision ( ) const

inlineinherited

Return current revision of the object.

Definition at line 139 of file DBAccessorBase.h.

139{ ensureAttached(); return m_entry->getRevision(); }

Belle2::DBStoreEntry::getRevision

unsigned int getRevision() const

get the revision of the payload, this is an abitrary number which indicates the conditions version

Definition: DBStoreEntry.h:97

◆ hasChanged()

bool hasChanged ( )

inline

Check whether the object has changed since the last call to hasChanged of the accessor).

Definition at line 89 of file DBAccessorBase.h.

    {
      const bool ret = m_changed;
      m_changed = false;
      return ret;
    }

◆ isIntraRunDependent()

bool isIntraRunDependent ( ) const

inlineinherited

Check wether this conditions object has some intra-run dependencies.

Definition at line 151 of file DBAccessorBase.h.

151{ ensureAttached(); return m_entry->isIntraRunDependent(); }

Belle2::DBStoreEntry::isIntraRunDependent

bool isIntraRunDependent() const

return whether or not the payload might change even during the run

Definition: DBStoreEntry.h:119

◆ isRequired()

bool isRequired ( ) const

inlineinherited

Check whether this conditions object is required (at least one user declared it as required)

Definition at line 160 of file DBAccessorBase.h.

160{ ensureAttached(); return m_entry->isRequired(); }

Belle2::DBStoreEntry::isRequired

bool isRequired() const

check whether this payload is required for operation

Definition: DBStoreEntry.h:115

◆ isValid()

bool isValid ( ) const

inline

Check whether a valid object was obtained from the database.

Returns: True if the object exists.

Definition at line 72 of file DBAccessorBase.h.

72{if (!ensureAttached()) return false; return (m_entry->getObject() != nullptr);}

◆ operator bool()

operator bool ( ) const

inlineinherited

Imitate pointer functionality.

Definition at line 74 of file DBAccessorBase.h.

◆ operator!=()

virtual bool operator!= ( const DBAccessorBase & other ) const

inlinevirtualinherited

Check if two store accessors point to a different object/array.

Definition at line 83 of file DBAccessorBase.h.

    {
      return !(*this == other);
    }

◆ operator==()

virtual bool operator== ( const DBAccessorBase & other ) const

inlinevirtualinherited

Check if two store accessors point to the same object/array.

Definition at line 77 of file DBAccessorBase.h.

    {
      return getName() == other.getName();
    }

◆ storeEntryChanged()

void storeEntryChanged ( bool destructed )

inlineprotectedinherited

Callback function which gets called by the DBStoreEntry object if it changes.

Definition at line 184 of file DBAccessorBase.h.

    {
      // we obviously changed
      m_changed = true;
      // StoreEntry is destructed, remove reference
      if (destructed) m_entry = nullptr;
      // Now run all registered callbacks
      // TODO: We could guard m_callbacks against insertions during callback
      // execution to prevent exponential growth of callbacks
      for (const auto& cb : m_callbacks) {
        if (destructed == cb.second) cb.first(m_name);
      }
    }

Member Data Documentation

◆ m_callbacks

std::vector<std::pair<std::function<void(const std::string&)>, bool> > m_callbacks

protectedinherited

List of all registered callback functions.

Definition at line 213 of file DBAccessorBase.h.

◆ m_changed

bool m_changed {false}

mutableprotectedinherited

Internal flag whether the object has changed since we last checked.

Definition at line 211 of file DBAccessorBase.h.

◆ m_entry

DBStoreEntry* m_entry

mutableprotectedinherited

Pointer to the entry in the DBStore.

Definition at line 209 of file DBAccessorBase.h.

◆ m_isArray

const bool m_isArray

protectedinherited

True if the payload is an array of objects.

Definition at line 205 of file DBAccessorBase.h.

◆ m_isRequired

const bool m_isRequired

protectedinherited

True if the payload is required, otherwise no errors will be raised if it cannot be found.

Definition at line 207 of file DBAccessorBase.h.

◆ m_name

const std::string m_name

protectedinherited

Name of the payload in the database.

Definition at line 201 of file DBAccessorBase.h.

◆ m_objClass

const TClass* m_objClass

protectedinherited

Class of the payload if type is c_Object.

Definition at line 203 of file DBAccessorBase.h.

◆ m_type

const DBStoreEntry::EPayloadType m_type

protectedinherited

Type of the payload.

Definition at line 199 of file DBAccessorBase.h.

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

framework/pybasf2/include/PyDBArray.h
framework/pybasf2/src/PyDBArray.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PyDBArray() [1/3]

◆ PyDBArray() [2/3]

◆ PyDBArray() [3/3]

Member Function Documentation

◆ __len__()

◆ _get()

◆ addCallback() [1/3]

◆ addCallback() [2/3]

◆ addCallback() [3/3]

◆ ensureAttached()

◆ getChecksum()

◆ getEntries()

◆ getFilename()

◆ getGlobaltag()

◆ getIntraRunBoundaries()

◆ getIntraRunBoundariesList()

◆ getIoV()

◆ getName()

◆ getObject()

◆ getRevision()

◆ hasChanged()

◆ isIntraRunDependent()

◆ isRequired()

◆ isValid()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ storeEntryChanged()

Member Data Documentation

◆ m_callbacks

◆ m_changed

◆ m_entry

◆ m_isArray

◆ m_isRequired

◆ m_name

◆ m_objClass

◆ m_type

◆ len()