DBImportBase Class Reference

Base class for importing objects to the database. More...

#include <DBImportBase.h>

Inheritance diagram for DBImportBase:

Collaboration diagram for DBImportBase:

Public Member Functions
	DBImportBase (const std::string &name)
	Constructor.
virtual	~DBImportBase ()
	Destructor.
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
	DBImportBase (const DBImportBase &)
	Hidden copy constructor.
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

Base class for importing objects to the database.

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

Definition at line 23 of file DBImportBase.h.

Member Enumeration Documentation

EIntraRunDependency

enum EIntraRunDependency

protected

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

DBImportBase() [1/2]

DBImportBase ( const std::string &  name )

inlineexplicit

Constructor.

Parameters

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

Definition at line 30 of file DBImportBase.h.

: m_name(name) {}

~DBImportBase()

~DBImportBase ( )

virtual

Destructor.

Definition at line 76 of file DBImportBase.cc.

{
  for (auto& object : m_objects) delete object;
}

DBImportBase() [2/2]

DBImportBase ( const DBImportBase &  )

private

Hidden copy constructor.

To prevent making copies, since the class contains pointer to allocated memory.

Member Function Documentation

addEventDependency()

virtual void addEventDependency ( unsigned int  eventNumber )

inlinevirtual

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  )

protected

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 )

inlinevirtual

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 )

inlinevirtual

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 ( )

virtual

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();
}

getName()

const std::string & getName ( ) const

inline

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

Returns

name

Definition at line 41 of file DBImportBase.h.

{return m_name;}

import() [1/2]

bool import

(

const IntervalOfValidity &

iov

)

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 )

inlineprivate

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);
    }

storeData()

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

private

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

private

dependency type

Definition at line 137 of file DBImportBase.h.

m_name

std::string m_name

protected

object or array name in database

Definition at line 99 of file DBImportBase.h.

m_object

TObject* m_object = 0

protected

pointer to allocated object or array

Definition at line 100 of file DBImportBase.h.

m_objects

std::vector<TObject*> m_objects

private

container for intra run dependency objects

Definition at line 138 of file DBImportBase.h.

m_tags

std::vector<unsigned long long int> m_tags

private

container for intra run dep.

tags

Definition at line 139 of file DBImportBase.h.

---

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

• framework/database/include/DBImportBase.h
• framework/database/src/DBImportBase.cc