StoreAccessorBase Class Reference

Base class for StoreObjPtr and StoreArray for easier common treatment. More...

#include <StoreAccessorBase.h>

Inheritance diagram for StoreAccessorBase:

Collaboration diagram for StoreAccessorBase:

Public Member Functions
	StoreAccessorBase (const std::string &name, DataStore::EDurability durability, TClass *objClass, bool isArray)
	Constructor to access an object or array in the DataStore.
virtual	~StoreAccessorBase ()
	Destructor.
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).

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?

Detailed Description

Base class for StoreObjPtr and StoreArray for easier common treatment.

Definition at line 27 of file StoreAccessorBase.h.

Constructor & Destructor Documentation

StoreAccessorBase()

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

inline

Constructor to access an object or array in the DataStore.

Parameters

name	Name under which the object is stored in the DataStore.
durability	Decides durability map used for getting the accessed object.
objClass	Type of the object
isArray	true if the entry in the DataStore is an array

Definition at line 37 of file StoreAccessorBase.h.

                                                                                                             :
      m_name(name), m_durability(durability), m_class(objClass), m_isArray(isArray) {}

~StoreAccessorBase()

virtual ~StoreAccessorBase ( )

inlinevirtual

Destructor.

Virtual because this is a base class.

Definition at line 44 of file StoreAccessorBase.h.

{}

Member Function Documentation

assign()

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

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

inlinevirtual

Clear contents of this object.

Reimplemented in RelationArray, StoreArray< T >, StoreArray< Particle >, StoreArray< Belle2::MCParticle >, StoreArray< Belle2::AWESOMESimHit >, StoreArray< Belle2::Particle >, StoreArray< Belle2::ECLCluster >, StoreArray< Belle2::KLMCluster >, StoreArray< Belle2::Track >, StoreArray< Belle2::TrackFitResult >, StoreArray< Belle2::V0 >, StoreArray< Belle2::BelleTrkExtra >, StoreArray< Belle2::PIDLikelihood >, StoreArray< Belle2::Btube >, StoreArray< Belle2::ContinuumSuppression >, StoreArray< Belle2::RestOfEvent >, StoreArray< Belle2::FlavorTaggerInfo >, StoreArray< Belle2::FlavorTaggerInfoMap >, StoreArray< Belle2::StringWrapper >, StoreArray< StoredClass >, StoreArray< TObject >, and StoreArray< Belle2::TagVertex >.

Definition at line 121 of file StoreAccessorBase.h.

    {
      create(true);
    }

create()

bool create ( bool  replace = false )

inline

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

getAccessorParams()

AccessorParams getAccessorParams ( ) const

inline

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

Definition at line 134 of file StoreAccessorBase.h.

{ return make_pair(m_name, m_durability);}

getClass()

TClass * getClass ( ) const

inline

The underlying object's type.

Definition at line 149 of file StoreAccessorBase.h.

{ return m_class; }

getDurability()

DataStore::EDurability getDurability ( ) const

inline

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

Definition at line 131 of file StoreAccessorBase.h.

{ return m_durability; }

getName()

const std::string & getName ( ) const

inline

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

Definition at line 128 of file StoreAccessorBase.h.

{ return m_name; }

isArray()

bool isArray ( ) const

inline

Is this an accessor for an array?

Definition at line 152 of file StoreAccessorBase.h.

{ return m_isArray; }

isOptional()

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

inline

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 = "" )

inline

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

notWrittenOut()

bool notWrittenOut

(

)

const

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

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

inlinevirtual

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

Definition at line 143 of file StoreAccessorBase.h.

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

operator==()

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

inlinevirtual

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

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  )

inline

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 )

inline

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

protected

The underlying object's type.

Definition at line 172 of file StoreAccessorBase.h.

m_durability

DataStore::EDurability m_durability

protected

Store durability under which the object/array is saved.

Definition at line 169 of file StoreAccessorBase.h.

m_isArray

bool m_isArray

protected

Is this an accessor for an array?

Definition at line 175 of file StoreAccessorBase.h.

m_name

std::string m_name

protected

Store name under which this object/array is saved.

Definition at line 166 of file StoreAccessorBase.h.

---

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

• framework/datastore/include/StoreAccessorBase.h
• framework/datastore/src/StoreAccessorBase.cc