Athena::ConditionsCleanerSvc Class Reference

Facade class for conditions garbage collection. More...

#include <ConditionsCleanerSvc.h>

Inheritance diagram for Athena::ConditionsCleanerSvc:

Collaboration diagram for Athena::ConditionsCleanerSvc:

Public Member Functions
	ConditionsCleanerSvc (const std::string &name, ISvcLocator *svc)
	Standard Gaudi constructor. More...
virtual StatusCode	initialize () override
	Standard Gaudi initialize method. More...
virtual StatusCode	event (const EventContext &ctx, bool allowAsync) override
	Called at the start of each event. More...
virtual StatusCode	condObjAdded (const EventContext &ctx, CondContBase &cc) override
	Called after a conditions object has been added. More...
virtual StatusCode	printStats () const override
	Print some statistics about the garbage collection. More...
virtual StatusCode	reset () override
	Clear the internal state of the service. More...

Private Attributes
ServiceHandle< Athena::IConditionsCleanerSvc >	m_cleanerSvc

Detailed Description

Facade class for conditions garbage collection.

This forwards calls to IConditionsCleanerSvc to the service that actually implements it. Done like this so that we need only specify the concrete class in one place. The concrete service may be left unspecified, in which case no garbage collection will be done.

Definition at line 35 of file ConditionsCleanerSvc.h.

Constructor & Destructor Documentation

ConditionsCleanerSvc()

Athena::ConditionsCleanerSvc::ConditionsCleanerSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Gaudi constructor.

Parameters

name	Service name.
svc	Service locator.

Definition at line 25 of file ConditionsCleanerSvc.cxx.

  : base_class (name, svc),
    m_cleanerSvc ("", name)
{
  declareProperty ("CleanerSvc", m_cleanerSvc,
                   "Service implementing conditions garbage collection.  "
                   "If blank, no garbage collection will be done.");
}

Member Function Documentation

condObjAdded()

StatusCode Athena::ConditionsCleanerSvc::condObjAdded ( const EventContext &  ctx, CondContBase &  cc  )

overridevirtual

Called after a conditions object has been added.

Parameters

ctx	The current event context.
cc	The container to which the object was added.

Definition at line 70 of file ConditionsCleanerSvc.cxx.

{
  if (!m_cleanerSvc.empty()) {
    return m_cleanerSvc->condObjAdded (ctx, cc);
  }
  return StatusCode::SUCCESS;
}

event()

StatusCode Athena::ConditionsCleanerSvc::event ( const EventContext &  ctx, bool  allowAsync  )

overridevirtual

Called at the start of each event.

Parameters

ctx	The current event context.
allowAsync	If true, then cleaning may be run in an asynchronous TBB task.

Definition at line 55 of file ConditionsCleanerSvc.cxx.

{
  if (!m_cleanerSvc.empty()) {
    return m_cleanerSvc->event (ctx, allowAsync);
  }
  return StatusCode::SUCCESS;
}

initialize()

StatusCode Athena::ConditionsCleanerSvc::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 39 of file ConditionsCleanerSvc.cxx.

{
  if (!m_cleanerSvc.empty()) {
    ATH_CHECK( m_cleanerSvc.retrieve() );
  }
  return StatusCode::SUCCESS;
}

printStats()

StatusCode Athena::ConditionsCleanerSvc::printStats ( ) const

overridevirtual

Print some statistics about the garbage collection.

Would generally be called in finalize(), but broken out as a separate interface for testing/debugging purposes.

Definition at line 85 of file ConditionsCleanerSvc.cxx.

{
  if (!m_cleanerSvc.empty()) {
    return m_cleanerSvc->printStats();
  }
  return StatusCode::SUCCESS;
}

reset()

StatusCode Athena::ConditionsCleanerSvc::reset ( )

overridevirtual

Clear the internal state of the service.

Only for testing. Don't call if any other thread may be touching the service.

Definition at line 98 of file ConditionsCleanerSvc.cxx.

{
  if (!m_cleanerSvc.empty()) {
    return m_cleanerSvc->reset();
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_cleanerSvc

ServiceHandle<Athena::IConditionsCleanerSvc> Athena::ConditionsCleanerSvc::m_cleanerSvc

private

Definition at line 88 of file ConditionsCleanerSvc.h.

---

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

• ConditionsCleanerSvc.h
• ConditionsCleanerSvc.cxx