Implementation of the IFileSvc interface, allowing algorithms to access ROOT files via a centralized service, and ensuring that files are shared appropriately and not unintentionally overwritten or duplicated. More...

Inheritance diagram for FileSvc:

[legend]

Collaboration diagram for FileSvc:

[legend]

Public Member Functions
	FileSvc (const std::string &name, ISvcLocator *svc)

StatusCode	initialize () override

StatusCode	finalize () override

std::shared_ptr< TFile >	getFile (const std::string &identifier) override
	Get a TFile pointer based on an identifier.

bool	hasIdentifier (const std::string &identifier) const override
	Check if a given identifier is known to the service.

Public Member Functions inherited from extends< Service, Gaudi::Interfaces::IFileSvc >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Public Attributes
Gaudi::Property< std::map< std::string, std::string > >	m_config

Private Member Functions
std::shared_ptr< TFile >	openFile (const std::string &filePath, const std::string &option, int compress)
	Open a file based on a specified path and opening mode.

StatusCode	closeFiles ()
	Close all files.

Private Attributes
std::unordered_map< std::string, size_t >	m_identifiers

std::vector< std::shared_ptr< TFile > >	m_files

Additional Inherited Members
Public Types inherited from extends< Service, Gaudi::Interfaces::IFileSvc >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

Implementation of the IFileSvc interface, allowing algorithms to access ROOT files via a centralized service, and ensuring that files are shared appropriately and not unintentionally overwritten or duplicated.

Files can be accessed via an identifier and should be listed at configuration time through the Config property.

Note that the paths given to Config property are URL syntax, that is they support extra paremeters in key=vlaue form after a '?' and seprated by '&' Supported parameters are : mode : one of 'CREATE' (default), 'RECREATE', 'UPDATE' compress : integer describing compression level to be used (see ROOT::RCompressionSetting::EDefaults)

Definition at line 39 of file FileSvc.cpp.

Constructor & Destructor Documentation

◆ FileSvc()

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

Definition at line 158 of file FileSvc.cpp.

158: base_class( name, svc ) {}

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition Service.cpp:333

extends< Service, Gaudi::Interfaces::IFileSvc >::base_class

extends base_class

Definition extends.h:23

Member Function Documentation

◆ closeFiles()

StatusCode FileSvc::closeFiles ( )

private

Close all files.

Returns: StatusCode indicating the success or failure of the operation.

Definition at line 209 of file FileSvc.cpp.

                               {
  for ( const auto& file : m_files ) {
    if ( file ) { file->Close(); }
  }
  m_files.clear();
  m_identifiers.clear();
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode FileSvc::finalize ( )

override

Definition at line 190 of file FileSvc.cpp.

190{ return closeFiles(); }

FileSvc::closeFiles

StatusCode closeFiles()

Close all files.

Definition FileSvc.cpp:209

◆ getFile()

std::shared_ptr< TFile > FileSvc::getFile ( const std::string & identifier )

override

Get a TFile pointer based on an identifier.

Parameters

identifier A string identifying the file (2 identifiers can point to the same TFile).

Returns: An shared pointer to a TFile object corresponding to the specified identifier.

Definition at line 192 of file FileSvc.cpp.

                                                                   {
  auto it = m_identifiers.find( boost::to_lower_copy( identifier ) );
  if ( it != m_identifiers.end() && it->second < m_files.size() ) { return m_files[it->second]; }
  error() << "No file associated with identifier: " << identifier << endmsg;
  return nullptr;
}

◆ hasIdentifier()

bool FileSvc::hasIdentifier ( const std::string & identifier ) const

override

Check if a given identifier is known to the service.

Definition at line 199 of file FileSvc.cpp.

                                                               {
  return m_identifiers.find( boost::to_lower_copy( identifier ) ) != m_identifiers.end();
}

◆ initialize()

StatusCode FileSvc::initialize ( )

override

Definition at line 160 of file FileSvc.cpp.

                               {
  return Service::initialize().andThen( [this]() {
    if ( checkConfig( m_config, *this ).isFailure() ) { return StatusCode::FAILURE; }
 
    for ( const auto& [identifier, path] : m_config ) {
      auto params = parseFilePath( path );
 
      // Check if this file is already opened and mapped
      if ( auto fileIndex = findFileIndex( m_files, params["path"] ) ) {
        // File already opened, just map the identifier to the existing index
        m_identifiers[boost::to_lower_copy( identifier )] = *fileIndex;
      } else {
        // File not found, open a new one
        int compress = ( params.find( "compress" ) != params.end() )
                           ? std::stoi( params["compress"] )
                           : ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault;
        if ( auto file = openFile( path, params["mode"], compress ) ) {
          m_files.push_back( std::move( file ) );
          m_identifiers[boost::to_lower_copy( identifier )] = m_files.size() - 1;
        } else {
          error() << "Failed to open file: " << params["path"] << endmsg;
          return StatusCode::FAILURE;
        }
      }
    }
 
    return StatusCode::SUCCESS;
  } );
}

◆ openFile()

std::shared_ptr< TFile > FileSvc::openFile	(	const std::string &	filePath,
		const std::string &	option,
		int	compress )

private

Open a file based on a specified path and opening mode.

Parameters

filePath	The file path.
option	The file opening options to pass to root ("NEW/CREATE", "RECREATE", "UPDATE").
compress	The compression level and algorithm to use for the file.

Returns: A shared_ptr to a newly opened TFile object, or null if the operation fails.

Definition at line 203 of file FileSvc.cpp.

                                                                                                         {
  auto file = std::make_shared<TFile>( filePath.c_str(), option.c_str(), "", compress );
  if ( !file || file->IsZombie() ) { return nullptr; }
  return file;
}

Member Data Documentation

◆ m_config

Gaudi::Property<std::map<std::string, std::string> > FileSvc::m_config

Initial value:

{

this, "Config", {}, "Map of keywords to file paths for file access" }

Definition at line 61 of file FileSvc.cpp.

61 {

62 this, "Config", {}, "Map of keywords to file paths for file access" };

◆ m_files

std::vector<std::shared_ptr<TFile> > FileSvc::m_files

private

Definition at line 86 of file FileSvc.cpp.

◆ m_identifiers

std::unordered_map<std::string, size_t> FileSvc::m_identifiers

private

Definition at line 83 of file FileSvc.cpp.

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

GaudiCoreSvc/src/FileSvc/FileSvc.cpp

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileSvc()

Member Function Documentation

◆ closeFiles()

◆ finalize()

◆ getFile()

◆ hasIdentifier()

◆ initialize()

◆ openFile()

Member Data Documentation

◆ m_config

◆ m_files

◆ m_identifiers