Stream event to an IServerSvc, which typically is a network server run from and controlled by the Athena application. More...

#include <StreamToServerTool.h>

Inheritance diagram for JiveXML::StreamToServerTool:

Collaboration diagram for JiveXML::StreamToServerTool:

Public Member Functions
	StreamToServerTool (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual StatusCode	initialize ()
	Initialize.
virtual StatusCode	finalize ()
	Finalize.
virtual StatusCode	StreamEvent (const unsigned long EventNumber, const unsigned int RunNumber, const std::ostringstream *const EventBuffer)
	Stream one event.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	The interface identifier.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
ServiceHandle< IServerSvc >	m_ServerSvc
	Handle to the server that this tools shall stream events to.
ServiceHandle< IOnlineEventDisplaysSvc >	m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_StreamName
	Stream name under which these events shall appear.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Stream event to an IServerSvc, which typically is a network server run from and controlled by the Athena application.

A stream name is attached to the events by doing so.

Author: Sebastian Boeser

Definition at line 25 of file StreamToServerTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ StreamToServerTool()

JiveXML::StreamToServerTool::StreamToServerTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	p )

Constructor.

setup message service
initialize properties

The name of the stream

The ServerSvc

Definition at line 14 of file StreamToServerTool.cxx.

                                                                                                           :
    AthAlgTool(type,name,p),
    m_ServerSvc("JiveXML::ONCRPCServerSvc",name){
 
    //Provide interface
    declareInterface<IStreamTool>(this);
    declareProperty("StreamName", m_StreamName = "default");
    declareProperty("ServerService", m_ServerSvc );
  }

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode JiveXML::StreamToServerTool::finalize ( )

virtual

Finalize.

Finalize - called once at the end.

Implements JiveXML::IStreamTool.

Definition at line 49 of file StreamToServerTool.cxx.

                                         {
    return StatusCode::SUCCESS;
  }

◆ initialize()

StatusCode JiveXML::StreamToServerTool::initialize ( )

virtual

Initialize.

Intialize - called once at the beginning.

Implements JiveXML::IStreamTool.

Definition at line 30 of file StreamToServerTool.cxx.

                                           {
 
    //Make sure we can get hold of the server and the online event displays service
    if (m_ServerSvc.retrieve().isFailure()){
      ATH_MSG_ERROR("Unable to initialize server service with name " << m_ServerSvc.name());
      return StatusCode::FAILURE;
    }
 
    if( m_onlineEDsvc.retrieve().isFailure()){
      ATH_MSG_ERROR("Could not locate the online event displays service");
      return StatusCode::FAILURE;
    }
 
    return StatusCode::SUCCESS;
  }

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & JiveXML::IStreamTool::interfaceID ( )

inlinestaticinherited

The interface identifier.

Definition at line 39 of file IStreamTool.h.

  { 
          return IID_IStreamTool; 
  }

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ StreamEvent()

StatusCode JiveXML::StreamToServerTool::StreamEvent	(	const unsigned long	EventNumber,
		const unsigned int	RunNumber,
		const std::ostringstream *const	EventBuffer )

virtual

Stream one event.

Stream one event to the server.

Parameters

EventNumber	the event number
RunNumber	the run number
EventBuffer	the string holding the complete event

Create an EventStreamID for this event

Stream this event to the server

Implements JiveXML::IStreamTool.

Definition at line 59 of file StreamToServerTool.cxx.

                                                                                           {
     m_StreamName = m_onlineEDsvc->getStreamName();
     ATH_MSG_VERBOSE("Streaming event Number " << EventNumber
                     << " from run Number " << RunNumber
                     << " to stream " << m_StreamName
                     << " on " << m_ServerSvc.name() << " service");
     EventStreamID evtStreamID(EventNumber,RunNumber,m_StreamName);
     return m_ServerSvc->UpdateEventForStream(evtStreamID,EventBuffer->str());
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_onlineEDsvc

ServiceHandle<IOnlineEventDisplaysSvc> JiveXML::StreamToServerTool::m_onlineEDsvc {this, "OnlineEventDisplaysSvc", "Online Event Displays Service"}

protected

Definition at line 45 of file StreamToServerTool.h.

45{this, "OnlineEventDisplaysSvc", "Online Event Displays Service"};

◆ m_ServerSvc

ServiceHandle<IServerSvc> JiveXML::StreamToServerTool::m_ServerSvc

protected

Handle to the server that this tools shall stream events to.

Definition at line 44 of file StreamToServerTool.h.

◆ m_StreamName

std::string JiveXML::StreamToServerTool::m_StreamName

private

Stream name under which these events shall appear.

Definition at line 49 of file StreamToServerTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ StreamToServerTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ StreamEvent()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_onlineEDsvc

◆ m_ServerSvc

◆ m_StreamName

◆ m_varHandleArraysDeclared

◆ m_vhka