ATLAS Offline Software
Public Member Functions | List of all members
IResetable Class Referenceabstract

a resetable object (e.g. a SG DataHandle) More...

#include <IResetable.h>

Inheritance diagram for IResetable:
Collaboration diagram for IResetable:

Public Member Functions

virtual ~IResetable ()
 
virtual void reset (bool hard)=0
 Clear cached data from this object. More...
 
virtual void finalReset ()
 optional special action on final reset call (e.g. in caller destructor) More...
 
virtual bool isSet () const =0
 
virtual const std::string & key () const =0
 

Detailed Description

a resetable object (e.g. a SG DataHandle)

Author
ATLAS Collaboration
Id
IResetable.h,v 1.2 2007-03-13 17:14:11 ssnyder Exp

Definition at line 15 of file IResetable.h.

Constructor & Destructor Documentation

◆ ~IResetable()

virtual IResetable::~IResetable ( )
inlinevirtual

Definition at line 17 of file IResetable.h.

17 {}

Member Function Documentation

◆ finalReset()

virtual void IResetable::finalReset ( )
inlinevirtual

optional special action on final reset call (e.g. in caller destructor)

Reimplemented in SG::VarHandleBase.

Definition at line 33 of file IResetable.h.

33 {};

◆ isSet()

virtual bool IResetable::isSet ( ) const
pure virtual

Implemented in SG::VarHandleBase, and DataHandleBase.

◆ key()

virtual const std::string& IResetable::key ( ) const
pure virtual

Implemented in SG::VarHandleBase, and DataHandleBase.

◆ reset()

virtual void IResetable::reset ( bool  hard)
pure virtual

Clear cached data from this object.

If HARD is true, then also clear any data that depends on the identity of the current event store. HARD will be set if the handle could potentially be looking at a different store the next time it is used. (This happens in Hive.)

For example, a VarHandle caches both a pointer to the referenced object and a pointer to the DataProxy used to reference it. If HARD is false, then only the object pointer need be cleared; but if it is true, then the DataProxy pointer should be cleared as well (and the object deregistered from the store).

Implemented in DataHandle< DATA >, DataHandle< ILArPedestal >, DataHandle< CondAttrListCollection >, DataHandle< ILArShape >, DataHandle< CondMultChanCollection >, DataHandle< ILArAutoCorr >, DataHandle< CaloRec::CaloCellFactor >, DataHandle< AthenaAttributeList >, DataHandle< GenericDbTable >, DataHandle< StrawDxContainer >, SG::VarHandleBase, and SG::UpdateHandle< T >.


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