Inheritance diagram for FileSvc:

[legend]

Collaboration diagram for FileSvc:

[legend]

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

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

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

Public Member Functions inherited from extends< Service, Gaudi::Interfaces::IFileSvc >
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...

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

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 More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

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

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

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

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

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

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. More...

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. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

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

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. More...

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. More...

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

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

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

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

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

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

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

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) More...

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

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)
	Open a file based on a specified path and opening mode. More...

StatusCode	closeFiles ()
	Close all files. More...

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 = 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 Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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

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

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...

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

	~Service () override
	Standard Destructor More...

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

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

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

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

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

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

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 More...

Detailed Description

Definition at line 23 of file FileSvc.cpp.

Constructor & Destructor Documentation

◆ FileSvc()

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

Definition at line 136 of file FileSvc.cpp.

136 : base_class( name, svc ) {}

Member Function Documentation

◆ closeFiles()

StatusCode FileSvc::closeFiles ( )

private

Close all files.

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

Definition at line 180 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 ( )

overridevirtual

Definition at line 165 of file FileSvc.cpp.

165 { return closeFiles(); }

◆ getFile()

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

overridevirtual

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 167 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;
 }

◆ initialize()

StatusCode FileSvc::initialize ( )

overridevirtual

Definition at line 138 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
         if ( auto file = openFile( path, params["mode"] ) ) {
           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
	)

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").

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

Definition at line 174 of file FileSvc.cpp.

                                                                                            {
   auto file = std::make_shared<TFile>( filePath.c_str(), option.c_str() );
   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 41 of file FileSvc.cpp.

◆ m_files

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

private

Definition at line 64 of file FileSvc.cpp.

◆ m_identifiers

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

private

Definition at line 61 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()

◆ initialize()

◆ openFile()

Member Data Documentation

◆ m_config

◆ m_files

◆ m_identifiers