Tool exposing a memory resource service as a memory resource tool. More...

#include <MemoryResourceSvcAdaptorTool.h>

Inheritance diagram for AthDevice::MemoryResourceSvcAdaptorTool:

Collaboration diagram for AthDevice::MemoryResourceSvcAdaptorTool:

Public Member Functions
Function(s) inherited from @c AthAlgTool
virtual StatusCode	initialize () override
	Initialize the tool.
Function(s) inherited from @c IMemoryResourceTool
virtual std::pmr::memory_resource &	mr () const override
	Get the provided `std::pmr::memory_resource` object.

Private Attributes
ServiceHandle< IMemoryResourceSvc >	m_mrSvc
	Handle to the service providing the underlying memory resource.

Detailed Description

Tool exposing a memory resource service as a memory resource tool.

Client components should ideally only use memory resources through the AthDevice::IMemoryResourceTool interface. But especially caching memory resources are best implemented as a service.

This tool allows us to expose such services with a tool interface.

Definition at line 25 of file MemoryResourceSvcAdaptorTool.h.

Member Function Documentation

◆ initialize()

StatusCode AthDevice::MemoryResourceSvcAdaptorTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 13 of file MemoryResourceSvcAdaptorTool.cxx.

                                                    {
 
  // Retrieve the "wrapped" service.
  ATH_CHECK(m_mrSvc.retrieve());
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

◆ mr()

std::pmr::memory_resource & AthDevice::MemoryResourceSvcAdaptorTool::mr ( ) const

overridevirtual

Get the provided std::pmr::memory_resource object.

Definition at line 22 of file MemoryResourceSvcAdaptorTool.cxx.

                                                              {
 
  // Just return the memory resource provided by the service.
  assert(m_mrSvc.isValid());
  return m_mrSvc->mr();
}

Member Data Documentation

◆ m_mrSvc

ServiceHandle<IMemoryResourceSvc> AthDevice::MemoryResourceSvcAdaptorTool::m_mrSvc

private

Initial value:

{

this, "MRSvc", "", "Service providing the 'adapted' memory resource"}

Handle to the service providing the underlying memory resource.

Definition at line 50 of file MemoryResourceSvcAdaptorTool.h.

50 {

51 this, "MRSvc", "", "Service providing the 'adapted' memory resource"};

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