Tool exposing a HIP stream service as a HIP stream tool. More...

#include <StreamSvcAdaptorTool.h>

Inheritance diagram for AthHIP::StreamSvcAdaptorTool:

Collaboration diagram for AthHIP::StreamSvcAdaptorTool:

Public Member Functions
Function(s) inherited from @c AthAlgTool
virtual StatusCode	initialize () override
	Initialize the tool.
Function(s) inherited from @c IStreamTool
virtual hipStream_t	stream (const EventContext &ctx) const override
	Get the HIP stream to use.

Private Attributes
ServiceHandle< IStreamSvc >	m_svc
	Handle to the service providing the HIP streams.

Detailed Description

Tool exposing a HIP stream service as a HIP stream tool.

Client components should ideally only use HIP streams through the AthHIP::IStreamTool interface. (For possible future flexibility.) But, at least initially, streams will just be provided by a relatively simple service.

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

Definition at line 26 of file AthHIP/AthHIPComps/src/StreamSvcAdaptorTool.h.

Member Function Documentation

◆ initialize()

StatusCode AthHIP::StreamSvcAdaptorTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 13 of file AthHIP/AthHIPComps/src/StreamSvcAdaptorTool.cxx.

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

◆ stream()

hipStream_t AthHIP::StreamSvcAdaptorTool::stream ( const EventContext & ctx ) const

overridevirtual

Get the HIP stream to use.

Parameters

ctx	The event context for which the stream is requested

Returns: The HIP stream to use for the current event context

Definition at line 22 of file AthHIP/AthHIPComps/src/StreamSvcAdaptorTool.cxx.

                                                                      {
 
  // Just return the stream provided by the service.
  assert(m_svc.isValid());
  return m_svc->stream(ctx);
}

Member Data Documentation

◆ m_svc

ServiceHandle<IStreamSvc> AthHIP::StreamSvcAdaptorTool::m_svc

private

Initial value:

{

this, "StreamSvc", "", "Service providing the 'adapted' HIP streams"}

Handle to the service providing the HIP streams.

Definition at line 54 of file AthHIP/AthHIPComps/src/StreamSvcAdaptorTool.h.

54 {

55 this, "StreamSvc", "", "Service providing the 'adapted' HIP streams"};

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