Class for accessing arrays of objects in the database. More...

#include <DBArray.h>

Inheritance diagram for DBArray< T >:

[legend]

Collaboration diagram for DBArray< T >:

[legend]

Public Types
typedef ObjArrayIterator< const TClonesArray, const T >	const_iterator
	STL-like const_iterator over the T objects (not T* ).

Public Member Functions
	DBArray (const std::string &name="", bool required=true)
	Constructor to access an array of objects in the DBStore. More...

int	getEntries () const
	Get the number of objects in the array.

const T *	operator[] (int i) const
	Access to the stored objects. More...

template<class KEY >
const T *	getByKey (KEY(T::*method)(void) const, KEY key) const
	Access object by key instead of by index. More...

const_iterator	begin () const
	Return const_iterator to first entry.

const_iterator	end () const
	Return const_iterator to last entry +1.

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

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

	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.

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

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

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

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

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	isRequired () const
	Check whether this conditions object is required (at least one user declared it as required)

Protected Member Functions
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. More...

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

Protected 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

template<class T>
class Belle2::DBArray< T >

Class for accessing arrays of objects in the database.

Definition at line 26 of file DBArray.h.

Constructor & Destructor Documentation

◆ DBArray()

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

inlineexplicit

Constructor to access an array of objects in the DBStore.

Parameters

name	Name under which the array is stored in the database (and DBStore).
required	if false there will be no errors if the object cannot be found in the database. However this will require the user to check if the object is valid before each use.

Definition at line 38 of file DBArray.h.

38 :

39 DBAccessorBase(DBStore::arrayName<T>(name), T::Class(), true, required) {}

Belle2::DBAccessorBase::DBAccessorBase

DBAccessorBase(const std::string &name, const TClass *objClass, bool isArray, bool isRequired)

Constructor to access an object in the DBStore.

Definition: DBAccessorBase.h:36

Member Function Documentation

◆ 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 119 of file DBAccessorBase.h.

◆ 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 106 of file DBAccessorBase.h.

◆ 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 131 of file DBAccessorBase.h.

◆ ensureAttached()

bool ensureAttached ( ) const

inlineprotectedinherited

Make sure we are attached to the the DBStore.

If not try to reconnect

Definition at line 163 of file DBAccessorBase.h.

◆ getByKey()

const T* getByKey	(	KEY(T::*)(void) const	method,
		KEY	key
	)		const

inline

Access object by key instead of by index.

Parameters

method	pointer to a member function of the objects in the array which will return the key for a given element
key	key to look for. If none of the elements return this key then NULL is returned

Definition at line 69 of file DBArray.h.

◆ isValid()

bool isValid ( ) const

inlineinherited

Check whether a valid object was obtained from the database.

Returns: True if the object exists.

Definition at line 73 of file DBAccessorBase.h.

◆ operator[]()

const T* operator[] ( int i ) const

inline

Access to the stored objects.

Out-of-bounds accesses throw an std::out_of_range exception

Parameters

i	Array index, should be in 0..getEntries()-1

Returns: pointer to the object

Definition at line 51 of file DBArray.h.

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

framework/database/include/DBArray.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class T> class Belle2::DBArray< T >

Constructor & Destructor Documentation

◆ DBArray()

Member Function Documentation

◆ addCallback() [1/3]

◆ addCallback() [2/3]

◆ addCallback() [3/3]

◆ ensureAttached()

◆ getByKey()

◆ isValid()

◆ operator[]()

template<class T>
class Belle2::DBArray< T >