Type-safe access to single objects in the data store. More...

#include <StoreObjPtr.h>

Inheritance diagram for StoreObjPtr< T >:

Public Member Functions
	StoreObjPtr (const std::string &name="", DataStore::EDurability durability=DataStore::c_Event)
	Constructor to access an object in the DataStore.

bool	isValid () const
	Check whether the object was created.

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

template<class ... Args>
bool	constructAndReplace (Args &&... params)
	Construct an object of type T in this StoreObjPtr, using the provided constructor arguments.

T &	operator* () const
	Imitate pointer functionality.

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

	operator bool () const
	Imitate pointer functionality.

bool	registerInDataStore (DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut)
	Register the object/array in the DataStore.

bool	registerInDataStore (const std::string &name, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut)
	Register the object/array in the DataStore.

bool	isRequired (const std::string &name="")
	Ensure this array/object has been registered previously.

bool	isOptional (const std::string &name="")
	Tell the DataStore about an optional input.

bool	create (bool replace=false)
	Create a default object in the data store.

bool	assign (TObject *object, bool replace=false)
	Assign 'object' to this accessor.

virtual void	clear ()
	Clear contents of this object.

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

DataStore::EDurability	getDurability () const
	Return durability with which the object is saved in the DataStore.

AccessorParams	getAccessorParams () const
	Return pair of name and durability under which stored object is saved.

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

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

TClass *	getClass () const
	The underlying object's type.

bool	isArray () const
	Is this an accessor for an array?

bool	notWrittenOut () const
	Returns true if this object/array should not be saved by output modules.

std::string	readableName () const
	Convert this acessor into a readable string (for messages).

Static Public Member Functions
static std::vector< std::string >	getObjectList (DataStore::EDurability durability=DataStore::c_Event)
	Return list of object names with matching type.

Protected Attributes
std::string	m_name
	Store name under which this object/array is saved.

DataStore::EDurability	m_durability
	Store durability under which the object/array is saved.

TClass *	m_class
	The underlying object's type.

bool	m_isArray
	Is this an accessor for an array?

Private Member Functions
void	ensureAttached () const
	Ensure that this object is attached.

void	ensureValid () const
	if accesses to this object would crash, throw an std::runtime_error

Private Attributes
TObject **	m_storeObjPtr
	Store of actual pointer.

Detailed Description

template<class T>
class Belle2::StoreObjPtr< T >

Type-safe access to single objects in the data store.

This class provides access to single (i.e. non-array) objects in the data store, identified by their name and durability.

Accessing existing objects

This example creates a new StoreObjPtr for the EventMetaData object, using the default name (EventMetaData) and default durability (event). If no object 'EventMetaData' is found in the data store, the store object pointer is invalid (accesses to it will cause an exception).

StoreObjPtr<EventMetaData> eventmetadata;
if(!eventmetadata) {
  B2INFO("an object called '" << eventmetadata.getName() << "' does not exist in the data store.");
} else {
  //object exists, you can now access its data
  B2INFO("we're currently in event " << eventmetadata->getEvent() << "!");
}

Storing objects

First, objects have to be registered in the data store during the initialization phase, meaning in the initialize method of a module:

void MyModule::initialize() {
  //register a single cdchit
  StoreObjPtr<CDCHit> cdchit;
  cdchit.registerInDataStore();
  //register a single cdchit under the name "AnotherHit" and do not write
  //it to the output file by default
  StoreObjPtr<CDCHit> cdchit2;
  cdchit2.registerInDataStore("AnotherHit", DataStore::c_DontWriteOut);
}

Before objects can be accessed they have to be created (in each event if the durability is c_Event):

//store a single cdchit
StoreObjPtr<CDCHit> cdchit;
cdchit.create(); // or construct() if you want to specify constructor arguments
cdchit->setCharge(5.0);

To put an existing object in the data store, use the assign method:

//store a single cdchit
CDCHit* cdchit = new CDCHit;
StoreObjPtr<CDCHit> cdchitPtr;
cdchitPtr.assign(cdchit);
cdchitPtr->setCharge(5.0);

Note that the datastore takes ownership of the object!

Using StoreOjbPtr as a module member variable

To avoid some overhead involved in re-creating the StoreObjPtr e.g. in each event() function call, you can also make StoreObjPtr a member variable of your class. If it is of non-event durability, you'll need to add the appropriate constructor call to the initializer list, e.g. (here with default name):

MyModule::MyModule():
  m_fooPtr("", DataStore::c_Persistent)
{}

In initialize(), you should also use registerInDataStore() or isOptional()/isRequired() to specify wether it is an input or output. For non-default names (which you might not know in the constructor, e.g. in the case of module parameters), set the 'name' argument of any of these three functions to permanently bind the StoreObjPtr to the array with the given name.

See also: If you want to store more than a single object of one type, use the StoreArray class.; Data can also be created/accessed from Python modules using PyStoreObj

Definition at line 96 of file StoreObjPtr.h.

Constructor & Destructor Documentation

◆ StoreObjPtr()

StoreObjPtr	(	const std::string &	name = `""`,
		DataStore::EDurability	durability = `DataStore::c_Event`
	)

inlineexplicit

Constructor to access an object in the DataStore.

Parameters

name	Name under which the object is stored in the DataStore. If an empty string is supplied, the type name will be used.
durability	Decides durability map used for getting the accessed object.

Definition at line 104 of file StoreObjPtr.h.

104 :

105 StoreAccessorBase(DataStore::objectName<T>(name), durability, T::Class(), false), m_storeObjPtr(0) {}

Belle2::StoreAccessorBase::StoreAccessorBase

StoreAccessorBase(const std::string &name, DataStore::EDurability durability, TClass *objClass, bool isArray)

Constructor to access an object or array in the DataStore.

Definition: StoreAccessorBase.h:37

Belle2::StoreObjPtr::m_storeObjPtr

TObject ** m_storeObjPtr

Store of actual pointer.

Definition: StoreObjPtr.h:170

Member Function Documentation

◆ assign()

bool assign	(	TObject *	object,
		bool	replace = `false`
	)

inherited

Assign 'object' to this accessor.

(takes ownership).

Parameters

object	The object that should be put in the DataStore, should be of same type as the one used by this accessor.
replace	Should an existing object be replaced? (if existing and supplied object are equal, this has no effect)

Returns: True if the assignment succeeded. If false, assign() will delete 'object', do not use it afterwards.

Definition at line 33 of file StoreAccessorBase.cc.

{
  if (not object)
    return false;
 
  bool success = false;
  const bool objIsArray = (object->IsA() == TClonesArray::Class());
  TClass* objClass = objIsArray ? (static_cast<TClonesArray*>(object))->GetClass() : object->IsA();
  if (objIsArray != isArray()) {
    B2ERROR("Cannot assign an object to an array (or vice versa); while assigning to " << readableName());
  } else if (objClass != getClass()) {
    B2ERROR("Cannot assign() an object of type '" << objClass->GetName() << "' to " << readableName() << " of type '" <<
            getClass()->GetName() << "'!");
  } else {
    success = DataStore::Instance().createObject(object, replace, *this);
  }
  if (!success)
    delete object;
  return success;
}

◆ clear()

virtual void clear ( )

inlinevirtualinherited

Clear contents of this object.

Definition at line 121 of file StoreAccessorBase.h.

    {
      create(true);
    }

◆ construct()

bool construct ( Args &&... params )

inline

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

If this StoreObjPtr already contains an object, this function will fail.

Returns: True if the creation succeeded.

Definition at line 119 of file StoreObjPtr.h.

    {
      T* t = new T(std::forward<Args>(params)...);
      return assign(t, false);
    }

◆ constructAndReplace()

bool constructAndReplace ( Args &&... params )

inline

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

If this StoreObjPtr already contains an object, it will be replaced.

Returns: True if the creation succeeded.

Definition at line 131 of file StoreObjPtr.h.

    {
      T* t = new T(std::forward<Args>(params)...);
      return assign(t, true);
    }

◆ create()

bool create ( bool replace = false )

inlineinherited

Create a default object in the data store.

This only works after registerInDataStore() has been called by this or another module.

Parameters

replace Should an existing object be replaced?

Returns: True if the creation succeeded.

Definition at line 107 of file StoreAccessorBase.h.

    {
      return DataStore::Instance().createObject(0, replace, *this);
    }

◆ ensureAttached()

void ensureAttached ( ) const

inlineprivate

Ensure that this object is attached.

Definition at line 155 of file StoreObjPtr.h.

    {
      if (!m_storeObjPtr) {
        const_cast<StoreObjPtr*>(this)->m_storeObjPtr = DataStore::Instance().getObject(*this);
      }
    }

◆ ensureValid()

void ensureValid ( ) const

inlineprivate

if accesses to this object would crash, throw an std::runtime_error

Definition at line 162 of file StoreObjPtr.h.

    {
      ensureAttached();
      if (!m_storeObjPtr || !(*m_storeObjPtr))
        throw std::runtime_error("Trying to access StoreObjPtr " + readableName() +
                                 ", which was not created. Please check isValid() before accesses if the object is not guaranteed to be created in every event.");
    }

◆ getAccessorParams()

AccessorParams getAccessorParams ( ) const

inlineinherited

Return pair of name and durability under which stored object is saved.

Definition at line 134 of file StoreAccessorBase.h.

134{ return make_pair(m_name, m_durability);}

Belle2::StoreAccessorBase::m_durability

DataStore::EDurability m_durability

Store durability under which the object/array is saved.

Definition: StoreAccessorBase.h:169

Belle2::StoreAccessorBase::m_name

std::string m_name

Store name under which this object/array is saved.

Definition: StoreAccessorBase.h:166

◆ getClass()

TClass * getClass ( ) const

inlineinherited

The underlying object's type.

Definition at line 149 of file StoreAccessorBase.h.

149{ return m_class; }

Belle2::StoreAccessorBase::m_class

TClass * m_class

The underlying object's type.

Definition: StoreAccessorBase.h:172

◆ getDurability()

DataStore::EDurability getDurability ( ) const

inlineinherited

Return durability with which the object is saved in the DataStore.

Definition at line 131 of file StoreAccessorBase.h.

131{ return m_durability; }

◆ getName()

const std::string & getName ( ) const

inlineinherited

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

Definition at line 128 of file StoreAccessorBase.h.

128{ return m_name; }

◆ getObjectList()

static std::vector< std::string > getObjectList ( DataStore::EDurability durability = DataStore::c_Event )

inlinestatic

Return list of object names with matching type.

Definition at line 148 of file StoreObjPtr.h.

    {
      return DataStore::Instance().getListOfObjects(T::Class(), durability);
    }

◆ isArray()

bool isArray ( ) const

inlineinherited

Is this an accessor for an array?

Definition at line 152 of file StoreAccessorBase.h.

152{ return m_isArray; }

Belle2::StoreAccessorBase::m_isArray

bool m_isArray

Is this an accessor for an array?

Definition: StoreAccessorBase.h:175

◆ isOptional()

bool isOptional ( const std::string & name = "" )

inlineinherited

Tell the DataStore about an optional input.

Mainly useful for creating diagrams of module inputs and outputs.

Parameters

name	If not empty, set non-default name for this object/array. This is permanent, so that e.g. after using registerInDataStore("myName") in initialize(), this object will continue refer to 'myName' in event().

Returns: True if the object/array exists.

Definition at line 93 of file StoreAccessorBase.h.

    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().optionalInput(*this);
    }

◆ isRequired()

bool isRequired ( const std::string & name = "" )

inlineinherited

Ensure this array/object has been registered previously.

Will cause an ERROR if it does not exist. This must be called in the initialization phase.

Parameters

name	If not empty, set non-default name for this object/array. This is permanent, so that e.g. after using registerInDataStore("myName") in initialize(), this object will continue refer to 'myName' in event().

Returns: True if the object/array exists.

Definition at line 78 of file StoreAccessorBase.h.

    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().requireInput(*this);
    }

◆ isValid()

bool isValid ( ) const

inline

Check whether the object was created.

Returns: True if the object exists.

Definition at line 111 of file StoreObjPtr.h.

111{ensureAttached(); return m_storeObjPtr && *m_storeObjPtr;}

◆ notWrittenOut()

bool notWrittenOut ( ) const

inherited

Returns true if this object/array should not be saved by output modules.

See DataStore::c_DontWriteOut. Can be changed by re-registering it with/without the flag.

Definition at line 53 of file StoreAccessorBase.cc.

{
  const DataStore::StoreEntry* entry = DataStore::Instance().getEntry(*this);
  if (!entry) {
    B2ERROR("notWrittenOut(): " << readableName() << " doesn't seem to  be registered");
    return false;
  }
  return entry->dontWriteOut;
}

◆ operator bool()

operator bool ( ) const

inline

Imitate pointer functionality.

Definition at line 144 of file StoreObjPtr.h.

◆ operator!=()

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

inlinevirtualinherited

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

Definition at line 143 of file StoreAccessorBase.h.

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

◆ operator*()

T & operator* ( ) const

inline

Imitate pointer functionality.

Definition at line 138 of file StoreObjPtr.h.

◆ operator->()

T * operator-> ( ) const

inline

Imitate pointer functionality.

Definition at line 142 of file StoreObjPtr.h.

◆ operator==()

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

inlinevirtualinherited

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

Definition at line 137 of file StoreAccessorBase.h.

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

◆ readableName()

std::string readableName ( ) const

inherited

Convert this acessor into a readable string (for messages).

e.g. "object EventMetaData (durability: event)"

Definition at line 18 of file StoreAccessorBase.cc.

{
  std::string str(isArray() ? "array" : "object");
  str += " '" + getName() + "' (durability: ";
  switch (getDurability()) {
    case DataStore::c_Event:
      str += "event";
      break;
    case DataStore::c_Persistent:
      str += "persistent";
      break;
  }
  return str + ")";
}

◆ registerInDataStore() [1/2]

bool registerInDataStore	(	const std::string &	name,
		DataStore::EStoreFlags	storeFlags = `DataStore::c_WriteOut`
	)

inlineinherited

Register the object/array in the DataStore.

This must be called in the initialization phase.

Parameters

name	If not empty, set non-default name for this object/array. This is permanent, so that e.g. after using registerInDataStore("myName") in initialize(), this object will continue refer to 'myName' in event().
storeFlags	ORed combination of DataStore::EStoreFlags.

Returns: True if the registration succeeded.

Definition at line 64 of file StoreAccessorBase.h.

    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().registerEntry(m_name, m_durability, getClass(), isArray(), storeFlags);
    }

◆ registerInDataStore() [2/2]

bool registerInDataStore ( DataStore::EStoreFlags storeFlags = DataStore::c_WriteOut )

inlineinherited

Register the object/array in the DataStore.

This must be called in the initialization phase.

Parameters

storeFlags ORed combination of DataStore::EStoreFlags.

Returns: True if the registration succeeded.

Definition at line 52 of file StoreAccessorBase.h.

    {
      return DataStore::Instance().registerEntry(m_name, m_durability, getClass(), isArray(), storeFlags);
    }

Member Data Documentation

◆ m_class

TClass* m_class

protectedinherited

The underlying object's type.

Definition at line 172 of file StoreAccessorBase.h.

◆ m_durability

DataStore::EDurability m_durability

protectedinherited

Store durability under which the object/array is saved.

Definition at line 169 of file StoreAccessorBase.h.

◆ m_isArray

bool m_isArray

protectedinherited

Is this an accessor for an array?

Definition at line 175 of file StoreAccessorBase.h.

◆ m_name

std::string m_name

protectedinherited

Store name under which this object/array is saved.

Definition at line 166 of file StoreAccessorBase.h.

◆ m_storeObjPtr

TObject** m_storeObjPtr

private

Store of actual pointer.

Don't make this a T** as this might cause problems with multiple inheritance objects

Definition at line 170 of file StoreObjPtr.h.

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

analysis/dataobjects/include/ParticleList.h
framework/datastore/include/StoreObjPtr.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Accessing existing objects

Storing objects

Using StoreOjbPtr as a module member variable

Constructor & Destructor Documentation

◆ StoreObjPtr()

Member Function Documentation

◆ assign()

◆ clear()

◆ construct()

◆ constructAndReplace()

◆ create()

◆ ensureAttached()

◆ ensureValid()

◆ getAccessorParams()

◆ getClass()

◆ getDurability()

◆ getName()

◆ getObjectList()

◆ isArray()

◆ isOptional()

◆ isRequired()

◆ isValid()

◆ notWrittenOut()

◆ operator bool()

◆ operator!=()

◆ operator*()

◆ operator->()

◆ operator==()

◆ readableName()

◆ registerInDataStore() [1/2]

◆ registerInDataStore() [2/2]

Member Data Documentation

◆ m_class

◆ m_durability

◆ m_isArray

◆ m_name

◆ m_storeObjPtr