Class for importing a single object to the database. More...

#include <DBImportObjPtr.h>

Inheritance diagram for DBImportObjPtr< T >:

Collaboration diagram for DBImportObjPtr< T >:

[legend]

Public Member Functions
	DBImportObjPtr (const std::string &name="")
	Constructor: the object itself is not allocated here, but in construct(...) function.

	~DBImportObjPtr ()
	Destructor.

template<class ... Args>
void	construct (Args &&... params)
	Construct an object of type T in this DBImportObjPtr using the provided constructor arguments.

T *	operator-> () const
	Imitate pointer functionality.

const std::string &	getName () const
	Returns the name under which the object will be stored in the database.

virtual void	addEventDependency (unsigned int eventNumber)
	add event dependency

virtual void	addTimeStampDependency (unsigned long long int timeStamp)
	add time stamp dependency

virtual void	addSubrunDependency (int subrun)
	add subrun dependency

bool	import (const IntervalOfValidity &iov)
	Import the object to database.

virtual void	clear ()
	Clear the content, e.g.

Protected Types
enum	EIntraRunDependency { c_None = 0 , c_Event = 1 , c_TimeStamp = 2 , c_Subrun = 3 }
	Intra run dependency types (used only internaly) More...

Protected Member Functions
void	addIntraRunDependency (unsigned long long int tag, EIntraRunDependency type)
	add intra run dependency

Protected Attributes
std::string	m_name
	object or array name in database

TObject *	m_object = 0
	pointer to allocated object or array

Private Member Functions
template<class IntraRun >
bool	import (const IntervalOfValidity &iov)
	Import intra run dependent object to database.

bool	storeData (TObject *intraRun, const IntervalOfValidity &iov)
	Store intra run dependent objects.

Private Attributes
EIntraRunDependency	m_dependency = c_None
	dependency type

std::vector< TObject * >	m_objects
	container for intra run dependency objects

std::vector< unsigned long long int >	m_tags
	container for intra run dep.

Detailed Description

template<class T>
class Belle2::DBImportObjPtr< T >

Class for importing a single object to the database.

Note that the object is NOT parked at DBStore, but allocated internally.

Definition at line 23 of file DBImportObjPtr.h.

Member Enumeration Documentation

◆ EIntraRunDependency

enum EIntraRunDependency

protectedinherited

Intra run dependency types (used only internaly)

Definition at line 86 of file DBImportBase.h.

                             { c_None = 0,
                               c_Event = 1,
                               c_TimeStamp = 2,
                               c_Subrun = 3
                             };

Constructor & Destructor Documentation

◆ DBImportObjPtr()

DBImportObjPtr ( const std::string & name = "" )

inlineexplicit

Constructor: the object itself is not allocated here, but in construct(...) function.

Parameters

name	Name under which the object will be stored in the database

Definition at line 31 of file DBImportObjPtr.h.

                                                       :
      DBImportBase(DBStore::objectName<T>(name))
    {}

◆ ~DBImportObjPtr()

~DBImportObjPtr ( )

inline

Destructor.

Definition at line 38 of file DBImportObjPtr.h.

    {
      if (m_object) delete m_object;
    }

Member Function Documentation

◆ addEventDependency()

virtual void addEventDependency ( unsigned int eventNumber )

inlinevirtualinherited

add event dependency

Parameters

eventNumber event number

Reimplemented in DBImportArray< T >.

Definition at line 47 of file DBImportBase.h.

    {
      addIntraRunDependency(eventNumber, c_Event);
    }

◆ addIntraRunDependency()

void addIntraRunDependency	(	unsigned long long int	tag,
		EIntraRunDependency	type
	)

protectedinherited

add intra run dependency

Parameters

tag	according to type: event number or time stamp or subrun number
type	intra run dependency type

Definition at line 17 of file DBImportBase.cc.

{
 
  if (!m_object) return;
 
  if (m_dependency == c_None) m_dependency = dependency;
  if (dependency == m_dependency) {
    m_objects.push_back(m_object);
    m_tags.push_back(tag);
    m_object = nullptr;
  } else {
    B2FATAL("DBImportBase::addIntraRunDependency: " <<
            "intra run dependency cannot be of mixed types");
  }
 
}

◆ addSubrunDependency()

virtual void addSubrunDependency ( int subrun )

inlinevirtualinherited

add subrun dependency

Parameters

subrun subrun number

Reimplemented in DBImportArray< T >.

Definition at line 65 of file DBImportBase.h.

    {
      addIntraRunDependency(subrun, c_Subrun);
    }

◆ addTimeStampDependency()

virtual void addTimeStampDependency ( unsigned long long int timeStamp )

inlinevirtualinherited

add time stamp dependency

Parameters

timeStamp time stamp

Reimplemented in DBImportArray< T >.

Definition at line 56 of file DBImportBase.h.

    {
      addIntraRunDependency(timeStamp, c_TimeStamp);
    }

◆ clear()

void clear ( )

virtualinherited

Clear the content, e.g.

destroy allocated objects and prepare for the new DB import.

Reimplemented in DBImportArray< T >.

Definition at line 58 of file DBImportBase.cc.

{
  if (m_object) {
    delete m_object;
    m_object = nullptr;
  }
 
  m_dependency = c_None;
  for (auto& object : m_objects) delete object;
  m_objects.clear();
  m_tags.clear();
}

◆ construct()

void construct ( Args &&... params )

inline

Construct an object of type T in this DBImportObjPtr using the provided constructor arguments.

Definition at line 47 of file DBImportObjPtr.h.

    {
      if (m_object) delete m_object;
      m_object = new T(std::forward<Args>(params)...);
    }

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name under which the object will be stored in the database.

Returns: name

Definition at line 41 of file DBImportBase.h.

41{return m_name;}

Belle2::DBImportBase::m_name

std::string m_name

object or array name in database

Definition: DBImportBase.h:99

◆ import() [1/2]

bool import ( const IntervalOfValidity & iov )

inherited

Import the object to database.

Parameters

iov	interval of validity

Definition at line 36 of file DBImportBase.cc.

{
 
  switch (m_dependency) {
    case c_Event:
      return import<EventDependency>(iov);
    case c_TimeStamp:
      B2ERROR("DBImportBase::import: " <<
              "intra run dependency of type 'time stamp' not supported yet");
      return false;
    case c_Subrun:
      B2ERROR("DBImportBase::import: " <<
              "intra run dependency of type 'subrun' not supported yet");
      return false;
    default:
      if (!m_object) return false;
      return Database::Instance().storeData(m_name, m_object, iov);
  }
 
}

◆ import() [2/2]

bool import ( const IntervalOfValidity & iov )

inlineprivateinherited

Import intra run dependent object to database.

Parameters

iov	interval of validity

Definition at line 114 of file DBImportBase.h.

    {
      if (m_objects.empty()) return false;
      IntraRun intraRun(m_objects[0], false); // IntraRun must not own the objects
 
      if (m_object) m_objects.push_back(m_object);
      for (unsigned i = 1; i < m_objects.size(); i++) {
        intraRun.add(m_tags[i - 1], m_objects[i]);
      }
      if (m_object) m_objects.pop_back(); // restore initial state (mandatory!)
 
      return storeData(&intraRun, iov);
    }

◆ operator->()

T * operator-> ( ) const

inline

Imitate pointer functionality.

Definition at line 56 of file DBImportObjPtr.h.

    {
      if (!m_object)
        throw std::out_of_range("DBImportObjPtr::operator ->, for "
                                + getName() + ", "
                                "object does not exist or is invisible");
      return static_cast<T*>(m_object);
    }

◆ storeData()

bool storeData	(	TObject *	intraRun,
		const IntervalOfValidity &	iov
	)

privateinherited

Store intra run dependent objects.

This is an extra function to hide implementation details of Database.h

Parameters

intraRun	pointer to the Intra Run implementation which has to inherit from TObject
iov	interval of validity

Definition at line 71 of file DBImportBase.cc.

{
  return Database::Instance().storeData(m_name, intraRun, iov);
}

Member Data Documentation

◆ m_dependency

EIntraRunDependency m_dependency = c_None

privateinherited

dependency type

Definition at line 137 of file DBImportBase.h.

◆ m_name

std::string m_name

protectedinherited

object or array name in database

Definition at line 99 of file DBImportBase.h.

◆ m_object

TObject* m_object = 0

protectedinherited

pointer to allocated object or array

Definition at line 100 of file DBImportBase.h.

◆ m_objects

std::vector<TObject*> m_objects

privateinherited

container for intra run dependency objects

Definition at line 138 of file DBImportBase.h.

◆ m_tags

std::vector<unsigned long long int> m_tags

privateinherited

container for intra run dep.

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EIntraRunDependency

Constructor & Destructor Documentation

◆ DBImportObjPtr()

◆ ~DBImportObjPtr()

Member Function Documentation

◆ addEventDependency()

◆ addIntraRunDependency()

◆ addSubrunDependency()

◆ addTimeStampDependency()

◆ clear()

◆ construct()

◆ getName()

◆ import() [1/2]

◆ import() [2/2]

◆ operator->()

◆ storeData()

Member Data Documentation

◆ m_dependency

◆ m_name

◆ m_object

◆ m_objects

◆ m_tags