RootDirectoryCnv.cpp

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
//------------------------------------------------------------------------------
//
// Implementation of class :  RootDirectoryCnv
//
// Author :                   Markus Frank
//
//------------------------------------------------------------------------------

#include <algorithm>
#include <memory>

// Include files
#include "GaudiKernel/IRegistry.h"
#include "GaudiKernel/NTuple.h"
#include "RootCnv/RootCnvSvc.h"
#include "RootCnv/RootDataConnection.h"
#include "RootCnv/RootDirectoryCnv.h"
#include "TBranch.h"

// Factory declaration
using namespace Gaudi;
using namespace std;

#if 0
DECLARE_COMPONENT_WITH_ID(RootDirectoryCnv,
                          ConverterID(POOL_StorageType,CLID_StatisticsDirectory))
#endif

// Standard Constructor
RootDirectoryCnv::RootDirectoryCnv( long typ, const CLID& clid, ISvcLocator* svc, RootCnvSvc* mgr )
    : RootStatCnv( typ, clid, svc, mgr ) {}

// Create transient object from persistent data
StatusCode RootDirectoryCnv::createObj( IOpaqueAddress* /* pAddr */, DataObject*& refpObj ) {
  refpObj = new NTuple::Directory();
  return StatusCode::SUCCESS;
}

// Converter overrides: Convert the transient object to the requested representation.
StatusCode RootDirectoryCnv::createRep( DataObject* pObj, IOpaqueAddress*& /* refpAddr */ ) {
  string dsc;
  if ( objType() == CLID_StatisticsDirectory ) {
    dsc = "Directory containing statistics results.";
  } else if ( objType() == CLID_StatisticsFile ) {
    dsc = "File containing statistics results.";
  } else {
    return StatusCode::FAILURE;
  }
  string ident = containerName( pObj->registry() );
  string path  = fileName( pObj->registry() );
  return saveDescription( path, ident, dsc, ident, objType() );
}

// Fill transient object references
StatusCode RootDirectoryCnv::fillObjRefs( IOpaqueAddress* pAddr, DataObject* pObj ) {
  return updateObjRefs( pAddr, pObj );
}

// Converter overrides: Update the references of an updated transient object.
StatusCode RootDirectoryCnv::updateObjRefs( IOpaqueAddress* pAddr, DataObject* pObject ) {
  typedef vector<RootNTupleDescriptor*> REFS;
  REFS                                  refs;
  StatusCode                            status = StatusCode( StatusCode::FAILURE, true );
  if ( pAddr ) {
    IRegistry* pReg = pAddr->registry();
    if ( pReg ) {
      typedef vector<IRegistry*> Leaves;
      string                     ident   = pReg->identifier();
      string                     fname   = fileName( pReg );
      string                     cntName = containerName( pReg );
      RootDataConnection*        con     = nullptr;
      Leaves                     leaves;
      status = m_dbMgr->connectDatabase( fname, IDataConnection::READ, &con );
      if ( status.isSuccess() ) {
        TBranch* b = con->getBranch( "##Descriptors", "GaudiStatisticsDescription" );
        if ( b ) {
          for ( Long64_t n = b->GetEntries(), i = 0; i < n; ++i ) {
            RootNTupleDescriptor* ref = nullptr;
            b->SetAddress( &ref );
            int nb = b->GetEntry( i );
            if ( nb > 1 ) {
              string s = ref->container.substr( 0, cntName.length() );
              log() << MSG::VERBOSE << "Read description:" << ref->container << " " << ident << " " << cntName
                    << endmsg;
              if ( s == cntName ) {
                if ( ref->container.length() >= cntName.length() + 1 ) {
                  if ( ref->container.find( '/', cntName.length() + 1 ) == string::npos ) {
                    refs.push_back( ref );
                    continue;
                  }
                }
              }
            }
            delete ref;
          }
        }
        log() << MSG::DEBUG << "Got " << refs.size() << " tuple connection(s)....." << endmsg;
        status = m_dataMgr->objectLeaves( pObject, leaves );
        if ( status.isSuccess() ) {
          for ( auto& ref : refs ) {
            if ( ref ) {
              bool need_to_add =
                  std::none_of( std::begin( leaves ), std::end( leaves ),
                                [&]( Leaves::const_reference j ) { return containerName( j ) == ref->container; } );
              if ( need_to_add ) {
                IOpaqueAddress* pA = nullptr;
                if ( ref->clid == CLID_StatisticsDirectory || ref->clid == CLID_StatisticsFile ||
                     ref->clid == CLID_RowWiseTuple || ref->clid == CLID_ColumnWiseTuple ) {
                  string        spar[] = {fname, ref->container};
                  unsigned long ipar[] = {~0x0UL, ~0x0UL};
                  status               = m_dbMgr->createAddress( repSvcType(), ref->clid, spar, ipar, pA );
                }
                if ( status.isSuccess() ) {
                  string top       = topLevel( pReg );
                  string leaf_name = top + ref->container.substr( 7 );
                  status           = m_dataMgr->registerAddress( leaf_name, pA );
                  if ( status.isSuccess() ) {
                    log() << MSG::DEBUG << "Created address for " << leaf_name << " of type " << ref->clid << endmsg;
                    continue;
                  }
                  makeError( "Failed to register leaves to directory:" + ident, false ).ignore();
                  break;
                }
                makeError( "Failed to create leave address to directory:" + ident, false ).ignore();
                break;
              }
            }
            makeError( "Failed to add leaves to directory:" + ident, false ).ignore();
            break;
          }
        }
      } else {
        return makeError( "Failed to access required tuple data description.", false );
      }
    }
  }
  for ( auto& ref : refs ) delete ref;
  return status;
}

// Converter overrides: Update transient object from persistent data
StatusCode RootDirectoryCnv::updateObj( IOpaqueAddress* /* pAddr */, DataObject* /* pObj */ ) {
  return StatusCode::SUCCESS;
}

// Converter overrides: Update persistent object representation.
StatusCode RootDirectoryCnv::updateRep( IOpaqueAddress* /* pAddr */, DataObject* /* pObj */ ) {
  return StatusCode::SUCCESS;
}

// Converter overrides: Update references of persistent object representation.
StatusCode RootDirectoryCnv::updateRepRefs( IOpaqueAddress* /* pAddr */, DataObject* /* pObj */ ) {
  return StatusCode::SUCCESS;
}

// Converter overrides: Fill references of persistent object representation.
StatusCode RootDirectoryCnv::fillRepRefs( IOpaqueAddress* /* pAddr */, DataObject* /* pObj */ ) {
  return StatusCode::SUCCESS;
}