AthDevice::DebugMemoryResourceTool Class Reference

Tool providing debugging functionality for memory resources. More...

#include <DebugMemoryResourceTool.h>

Inheritance diagram for AthDevice::DebugMemoryResourceTool:

Collaboration diagram for AthDevice::DebugMemoryResourceTool:

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

Private Attributes
std::unique_ptr< std::pmr::memory_resource >	m_mr
	The memory resource that this tool uses.
Tool properties
ToolHandle< IMemoryResourceTool >	m_mrTool
	Underlying memory resource to use for allocations.

Detailed Description

Tool providing debugging functionality for memory resources.

Making use of vecmem::debug_memory_resource.

Definition at line 20 of file DebugMemoryResourceTool.h.

Member Function Documentation

initialize()

StatusCode AthDevice::DebugMemoryResourceTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 13 of file DebugMemoryResourceTool.cxx.

                                               {
 
  // Retrieve the upstream tool.
  ATH_CHECK(m_mrTool.retrieve());
 
  // Construct the debug resource around it.
  m_mr = std::make_unique<vecmem::debug_memory_resource>(m_mrTool->mr());
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

mr()

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

overridevirtual

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

Definition at line 25 of file DebugMemoryResourceTool.cxx.

                                                         {
 
  assert(m_mr);
  return *m_mr;
}

Member Data Documentation

m_mr

std::unique_ptr<std::pmr::memory_resource> AthDevice::DebugMemoryResourceTool::m_mr

private

The memory resource that this tool uses.

Definition at line 45 of file DebugMemoryResourceTool.h.

m_mrTool

ToolHandle<IMemoryResourceTool> AthDevice::DebugMemoryResourceTool::m_mrTool

private

Initial value:

{
      this, "MRTool", "", "Memory resource tool to use for allocations"}

Underlying memory resource to use for allocations.

Definition at line 51 of file DebugMemoryResourceTool.h.

                                          {
      this, "MRTool", "", "Memory resource tool to use for allocations"};

---

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

• DebugMemoryResourceTool.h
• DebugMemoryResourceTool.cxx