RecordDataSvc Class Reference

A RecordDataSvc is the base class for event services. More...

#include <src/DataSvc/RecordDataSvc.h>

Inheritance diagram for RecordDataSvc:

Collaboration diagram for RecordDataSvc:

Public Member Functions
StatusCode	initialize () override
	Service initialisation. More...
StatusCode	finalize () override
	Service finalization. More...
void	handle (const Incident &incident) override
	IIncidentListener override: Inform that a new incident has occured. More...
	RecordDataSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
	~RecordDataSvc () override=default
	Standard Destructor. More...
Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
void	registerRecord (const std::string &data, IOpaqueAddress *pAddr)
	Load new record into the data store if necessary. More...
void	loadRecords (IRegistry *pReg)
	Load dependent records into memory. More...

Protected Attributes
bool	m_autoLoad
	Property: autoload of records (default: true) More...
std::string	m_incidentName
	Property: name of incident to be fired if new record arrives. More...
std::string	m_saveIncidentName
	Property: name of the "save" incident. More...
std::string	m_persSvcName
	Property: name of the persistency service. More...
std::vector< std::string >	m_incidents
	Pending new file incidents. More...
SmartIF< IConversionSvc >	m_cnvSvc
	Reference to the main data conversion service. More...

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

A RecordDataSvc is the base class for event services.

When a new datafile is opened the data service retrieves an incident from the persistency area (currently only from POOL) together with an opaque address describing the record. These history records are put onto the run-records datastore under the name of the logical file (FID): /Records/<FID>/.....

Hence, each history records can be addresses the same way: /Record/<FID> (/EOR)

Author

M.Frank

Version

1.0

Definition at line 25 of file RecordDataSvc.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 158 of file RecordDataSvc.cpp.

: base_class(name,svc)
{
  m_rootName = "/Records";
  declareProperty("AutoLoad",       m_autoLoad = true);
  declareProperty("IncidentName",   m_incidentName = "");
  declareProperty("SaveIncident",   m_saveIncidentName = "SAVE_RECORD");
  declareProperty("PersistencySvc", m_persSvcName = "PersistencySvc/RecordPersistencySvc");
}

RecordDataSvc::~RecordDataSvc ( )

overridedefault

Standard Destructor.

Member Function Documentation

StatusCode RecordDataSvc::finalize ( )

override

Service finalization.

Definition at line 84 of file RecordDataSvc.cpp.

                                      {
  if( m_incidentSvc ) m_incidentSvc->removeListener(this);
  m_cnvSvc.reset();
  DataSvc::finalize().ignore();
  return StatusCode::SUCCESS ;
}

void RecordDataSvc::handle ( const Incident &  incident )

override

IIncidentListener override: Inform that a new incident has occured.

Inform that a new incident has occured.

Definition at line 92 of file RecordDataSvc.cpp.

                                                   {
  if ( incident.type() == "FILE_OPEN_READ" ) {
    typedef ContextIncident<IOpaqueAddress*> Ctxt;
    auto inc = dynamic_cast<const Ctxt*>(&incident);
    if ( !inc )  {
        MsgStream log(msgSvc(),name());
        log << MSG::ALWAYS << "Received invalid incident of type:" << incident.type() << endmsg;
    } else {
      registerRecord(inc->source(),inc->tag());
      if ( !m_incidentName.empty() ) {
        auto  incidents = m_incidents;
        m_incidents.clear();
        for( const auto& i : incidents) 
            m_incidentSvc->fireIncident(Incident{i,m_incidentName});
      }
    }
  } else if ( incident.type() == m_saveIncidentName ) {
    MsgStream log(msgSvc(),name());
    log << MSG::ALWAYS << "Saving records not implemented." << endmsg;
  }
}

StatusCode RecordDataSvc::initialize ( )

override

Service initialisation.

We need to subscribe to 2 incident: 1) FILE_OPEN_READ: fired by conversion service on open file 2) IncidentType::BeginEvent fired by event loop BEFORE the event processing starts. Do everything to bootstract access to the old event record.

Definition at line 39 of file RecordDataSvc.cpp.

                                        {
  // Nothing to do: just call base class initialisation
  StatusCode      sc  = DataSvc::initialize();
  MsgStream log(msgSvc(),name());

  if ( !sc.isSuccess() ) { // Base class failure
    return sc;
  }
  // Attach data loader facility
  m_cnvSvc = service(m_persSvcName, true);
  if ( !m_cnvSvc) {
    log << MSG::ERROR << "Failed to access RecordPersistencySvc." << endmsg;
    return StatusCode::FAILURE;
  }
  auto prp = m_cnvSvc.as<IProperty>();
  if ( prp ) {
    //prp->setProperty();
  }
  sc = setDataLoader( m_cnvSvc.get() );
  if ( !sc.isSuccess() ) {
    log << MSG::ERROR << "Failed to attach dataloader RecordPersistencySvc." << endmsg;
    return sc;
  }

  sc = setRoot(m_rootName, new DataObject());
  if( !sc.isSuccess() )  {
    log << MSG::WARNING << "Error declaring Record root DataObject" << endmsg;
    return sc;
  }

  if( !m_incidentSvc )  {
    log << MSG::FATAL << "IncidentSvc is invalid--base class failed." << endmsg;
    return sc;
  }

  m_incidentSvc->addListener(this,"FILE_OPEN_READ");
  m_incidentSvc->addListener(this,m_saveIncidentName);
  return sc;
}

void RecordDataSvc::loadRecords ( IRegistry *  pReg )

protected

Load dependent records into memory.

Definition at line 115 of file RecordDataSvc.cpp.

                                               {
  MsgStream log(msgSvc(),name());
  if ( !pObj )    {
      log << MSG::ERROR << "Failed to load records object: " << pObj->identifier() << endmsg;
  } else {
    vector<IRegistry*> leaves;
    DataObject* p = nullptr;
    const string& id0 = pObj->identifier();
    StatusCode sc = retrieveObject(id0, p);
    if ( sc.isSuccess() ) {
      log << MSG::DEBUG << "Loaded records object: " << id0 << endmsg;
      sc = objectLeaves(pObj, leaves);
      if ( sc.isSuccess() )  {
        for ( const auto& i : leaves) loadRecords(i);
      }
    }
  }
}

void RecordDataSvc::registerRecord ( const std::string &  data, IOpaqueAddress *  pAddr  )

protected

Load new record into the data store if necessary.

Load new run record into the data store if necessary.

Definition at line 135 of file RecordDataSvc.cpp.

                                                                              {
  if ( !data.empty() && pAddr ) {
    MsgStream log(msgSvc(),name());
    string fid = data;
    log << MSG::DEBUG << "Request to load record for file " << fid << endmsg;
    StatusCode sc = registerAddress(m_root,fid,pAddr);
    if ( !sc.isSuccess() ) {
      log << MSG::WARNING << "Failed to register record for:" << fid << endmsg;
      pAddr->release();
      return;
    }
    if ( m_autoLoad ) {
      loadRecords(pAddr->registry());
    }
    m_incidents.push_back(pAddr->registry()->identifier());
  }
  else if ( !data.empty() && !pAddr ) {
    MsgStream log(msgSvc(),name());
    log << MSG::INFO << "Failed to register record for:" << data << " [Invalid Address]" << endmsg;
  }
}

Member Data Documentation

bool RecordDataSvc::m_autoLoad

protected

Property: autoload of records (default: true)

Definition at line 48 of file RecordDataSvc.h.

SmartIF<IConversionSvc> RecordDataSvc::m_cnvSvc

protected

Reference to the main data conversion service.

Definition at line 58 of file RecordDataSvc.h.

std::string RecordDataSvc::m_incidentName

protected

Property: name of incident to be fired if new record arrives.

Definition at line 50 of file RecordDataSvc.h.

std::vector<std::string> RecordDataSvc::m_incidents

protected

Pending new file incidents.

Definition at line 56 of file RecordDataSvc.h.

std::string RecordDataSvc::m_persSvcName

protected

Property: name of the persistency service.

Definition at line 54 of file RecordDataSvc.h.

std::string RecordDataSvc::m_saveIncidentName

protected

Property: name of the "save" incident.

Definition at line 52 of file RecordDataSvc.h.

---

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

• GaudiCommonSvc/src/DataSvc/RecordDataSvc.h
• GaudiCommonSvc/src/DataSvc/RecordDataSvc.cpp