#include </builds/gaudi/Gaudi/GaudiMP/src/component/IoComponentMgr.h>

Inheritance diagram for IoComponentMgr:

[legend]

Collaboration diagram for IoComponentMgr:

[legend]

Classes
struct	IoComponentEntry

Public Member Functions
StatusCode	initialize () override
	Gaudi Service Implementation. More...

StatusCode	finalize () override

void	handle (const Incident &) override

bool	io_hasitem (IIoComponent *iocomponent) const override
	: check if the registry contains a given `IIoComponent` More...

bool	io_contains (IIoComponent *iocomponent, const std::string &fname) const override
	: check if the registry contains a given `IIoComponent` and that component had More...

StatusCode	io_register (IIoComponent *iocomponent) override
	: allow a `IIoComponent` to register itself with this manager so appropriate actions can be taken when e.g. More...

StatusCode	io_register (IIoComponent *iocomponent, IIoComponentMgr::IoMode::Type iomode, const std::string &fname, const std::string &pfn) override
	: allow a `IIoComponent` to register itself with this manager so appropriate actions can be taken when e.g. More...

StatusCode	io_update (IIoComponent *iocomponent, const std::string &old_fname, const std::string &new_fname) override
	: allow a `IIoComponent` to update the contents of the registry with a new file name More...

StatusCode	io_update (IIoComponent *iocomponent, const std::string &work_dir) override
	: allow a `IIoComponent` to update the contents of the registry with a new work directory More...

StatusCode	io_update_all (const std::string &work_dir) override
	: Update all `IIoComponents` with a new work directory More...

std::vector< std::string >	io_retrieve (IIoComponent *iocomponent) override
	: retrieve all registered filenames for a given `IIoComponent` More...

StatusCode	io_retrieve (IIoComponent *iocomponent, std::string &fname) override
	: retrieve the new filename for a given `IIoComponent` and More...

StatusCode	io_reinitialize () override
	: reinitialize the I/O subsystem. More...

StatusCode	io_finalize () override
	: finalize the I/O subsystem. More...

Public Member Functions inherited from extends< Service, IIoComponentMgr, IIncidentListener >
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...

Private Types
typedef std::map< std::string, IIoComponent * >	IoRegistry_t

typedef std::list< IIoComponent * >	IoStack_t

typedef std::multimap< IIoComponent *, IoComponentEntry >	IoDict_t

typedef IoDict_t::const_iterator	iodITR

Private Member Functions
	IoComponentMgr ()=delete
	Default constructor: More...

bool	findComp (IIoComponent *, const std::string &, iodITR &) const

bool	findComp (IIoComponent *, std::pair< iodITR, iodITR > &) const

bool	findComp (const std::string &, std::pair< iodITR, iodITR > &) const

std::string	list () const

Private Attributes
IoRegistry_t	m_ioregistry
	Registry of `IIoComponents`. More...

IoStack_t	m_iostack
	Stack of `IIoComponents` to properly handle order of registration. More...

IoDict_t	m_cdict

std::string	m_dict_location
	location of the python dictionary More...

Gaudi::Property< std::vector< std::string > >	m_directio_patterns
	search patterns for special file names (direct I/O protocols) More...

Additional Inherited Members
Public Types inherited from extends< Service, IIoComponentMgr, IIncidentListener >
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 39 of file IoComponentMgr.h.

Member Typedef Documentation

◆ IoDict_t

typedef std::multimap<IIoComponent*, IoComponentEntry> IoComponentMgr::IoDict_t

private

Definition at line 171 of file IoComponentMgr.h.

◆ iodITR

typedef IoDict_t::const_iterator IoComponentMgr::iodITR

private

Definition at line 172 of file IoComponentMgr.h.

◆ IoRegistry_t

typedef std::map<std::string, IIoComponent*> IoComponentMgr::IoRegistry_t

private

Definition at line 162 of file IoComponentMgr.h.

◆ IoStack_t

typedef std::list<IIoComponent*> IoComponentMgr::IoStack_t

private

Definition at line 166 of file IoComponentMgr.h.

Constructor & Destructor Documentation

◆ IoComponentMgr()

IoComponentMgr::IoComponentMgr ( )

privatedelete

Default constructor:

Member Function Documentation

◆ finalize()

StatusCode IoComponentMgr::finalize ( )

override

Definition at line 86 of file IoComponentMgr.cpp.

                                     {
   DEBMSG << "--> finalize()" << endmsg;
  
   for ( auto& io : m_iostack ) { io->release(); }
  
   return StatusCode::SUCCESS;
 }

◆ findComp() [1/3]

bool IoComponentMgr::findComp	(	const std::string &	c,
		std::pair< iodITR, iodITR > &	pit
	)		const

private

Definition at line 422 of file IoComponentMgr.cpp.

                                                                                       {
  
   pit.first  = m_cdict.end();
   pit.second = m_cdict.end();
  
   auto itr = m_ioregistry.find( c );
   return ( itr != m_ioregistry.end() ) && findComp( itr->second, pit );
 }

◆ findComp() [2/3]

bool IoComponentMgr::findComp	(	IIoComponent *	c,
		const std::string &	f,
		iodITR &	itr
	)		const

private

Definition at line 402 of file IoComponentMgr.cpp.

                                                                                       {
  
   pair<iodITR, iodITR> pit;
   if ( !findComp( c, pit ) ) {
     itr = pit.first;
     return false;
   }
   return std::any_of( pit.first, pit.second, [&]( IoDict_t::const_reference i ) { return i.second.m_oldfname == f; } );
 }

◆ findComp() [3/3]

bool IoComponentMgr::findComp	(	IIoComponent *	c,
		std::pair< iodITR, iodITR > &	pit
	)		const

private

Definition at line 414 of file IoComponentMgr.cpp.

                                                                                    {
  
   pit = m_cdict.equal_range( c );
   return pit.first != pit.second;
 }

◆ handle()

void IoComponentMgr::handle ( const Incident & i )

override

Definition at line 445 of file IoComponentMgr.cpp.

                                                {
  
   pair<iodITR, iodITR> pit;
  
   if ( i.type() == IncidentType::BeginInputFile ) {
  
     const FileIncident* fi = dynamic_cast<const FileIncident*>( &i );
     DEBMSG << "BeginInputFile:   s: " << fi->source() << "  t: " << fi->type() << "  n: " << fi->fileName()
            << "  g: " << fi->fileGuid() << endmsg;
  
     if ( findComp( fi->source(), pit ) ) {
       DEBMSG << "  found component: " << endmsg;
       while ( pit.first != pit.second ) {
         IIoComponent*    c = pit.first->first;
         IoComponentEntry e = pit.first->second;
         DEBMSG << "    c: " << c->name() << "  " << e << endmsg;
  
         ++pit.first;
       }
     } else {
       DEBMSG << "  could not find component \"" << fi->source() << "\"!" << endmsg;
     }
  
   } else if ( i.type() == IncidentType::BeginOutputFile ) {
  
     const FileIncident* fi = dynamic_cast<const FileIncident*>( &i );
     DEBMSG << "BeginOutputFile:   s: " << fi->source() << "  t: " << fi->type() << "  n: " << fi->fileName()
            << "  g: " << fi->fileGuid() << endmsg;
  
     if ( findComp( fi->source(), pit ) ) {
       DEBMSG << "  found component: " << endmsg;
       while ( pit.first != pit.second ) {
         IIoComponent*    c = pit.first->first;
         IoComponentEntry e = pit.first->second;
         DEBMSG << "    c: " << c->name() << "  " << e << endmsg;
  
         ++pit.first;
       }
     } else {
       DEBMSG << "  could not find component \"" << fi->source() << "\"!" << endmsg;
     }
   }
 }

◆ initialize()

StatusCode IoComponentMgr::initialize ( )

override

Gaudi Service Implementation.

Definition at line 63 of file IoComponentMgr.cpp.

                                       {
   DEBMSG << "--> initialize()" << endmsg;
  
   if ( Service::initialize().isFailure() ) {
     error() << "Unable to initialize Service base class" << endmsg;
     return StatusCode::FAILURE;
   }
  
   auto p_incSvc = service<IIncidentSvc>( "IncidentSvc", true );
  
   if ( !p_incSvc ) {
     error() << "unable to get the IncidentSvc" << endmsg;
     return StatusCode::FAILURE;
   } else {
     p_incSvc->addListener( this, IncidentType::BeginOutputFile, 100, true );
     p_incSvc->addListener( this, IncidentType::BeginInputFile, 100, true );
   }
  
   return StatusCode::SUCCESS;
 }

◆ io_contains()

bool IoComponentMgr::io_contains	(	IIoComponent *	iocomponent,
		const std::string &	fname
	)		const

override

: check if the registry contains a given IIoComponent and that component had

Parameters

<tt>fname</tt> as a filename

Definition at line 111 of file IoComponentMgr.cpp.

                                                                                           {
   DEBMSG << "--> io_contains()" << endmsg;
   if ( 0 == iocomponent ) { return false; }
   const std::string& ioname = iocomponent->name();
  
   DEBMSG << "io_contains:  c: " << ioname << " f: " << fname << endmsg;
  
   pair<iodITR, iodITR> fit = m_cdict.equal_range( iocomponent );
   if ( fit.first == fit.second ) {
     return false;
   } else {
     iodITR it;
     for ( it = fit.first; it != fit.second; ++it ) {
       IoComponentEntry ioe = it->second;
       DEBMSG << "   " << ioe << endmsg;
       if ( ioe.m_oldfname == "" ) {
         error() << "IIoComponent " << ioname << "  has empty old filename" << endmsg;
         return false;
       } else if ( ioe.m_oldfname == fname ) {
         return true;
       }
     }
   }
  
   return false;
 }

◆ io_finalize()

StatusCode IoComponentMgr::io_finalize ( )

override

: finalize the I/O subsystem.

Hook to allow to e.g. give a chance to I/O subsystems to merge output files. Not sure how to do this correctly though...

Definition at line 379 of file IoComponentMgr.cpp.

                                        {
   ON_DEBUG {
     debug() << "--> io_finalize()" << endmsg;
     debug() << "finalizing I/O subsystem..." << endmsg;
     debug() << "Listing all monitored entries: " << std::endl;
     debug() << list() << endmsg;
   }
  
   bool allgood = true;
   // reverse iteration to unwind component dependencies
   for ( IoStack_t::reverse_iterator io = m_iostack.rbegin(), ioEnd = m_iostack.rend(); io != ioEnd; ++io ) {
     DEBMSG << " [" << ( *io )->name() << "]->io_finalize()..." << endmsg;
     if ( !( *io )->io_finalize().isSuccess() ) {
       allgood = false;
       error() << "problem in [" << ( *io )->name() << "]->io_finalize() !" << endmsg;
     }
   }
  
   return allgood ? StatusCode::SUCCESS : StatusCode::FAILURE;
 }

◆ io_hasitem()

bool IoComponentMgr::io_hasitem ( IIoComponent * iocomponent ) const

override

: check if the registry contains a given IIoComponent

Definition at line 98 of file IoComponentMgr.cpp.

                                                                  {
   DEBMSG << "--> io_hasitem()" << endmsg;
   if ( 0 == iocomponent ) { return false; }
   const std::string&           ioname = iocomponent->name();
   IoRegistry_t::const_iterator io     = m_ioregistry.find( ioname );
   return io != m_ioregistry.end();
 }

◆ io_register() [1/2]

StatusCode IoComponentMgr::io_register ( IIoComponent * iocomponent )

override

: allow a IIoComponent to register itself with this manager so appropriate actions can be taken when e.g.

a fork(2) has been issued (this is usually handled by calling IIoComponent::io_reinit on every registered component)

Definition at line 146 of file IoComponentMgr.cpp.

                                                                   {
   if ( !iocomponent ) {
     error() << "io_register (component) received a NULL pointer !" << endmsg;
     return StatusCode::FAILURE;
   }
   const std::string& ioname = iocomponent->name();
   DEBMSG << "--> io_register(" << ioname << ")" << endmsg;
   auto itr = m_ioregistry.find( ioname );
   if ( itr == m_ioregistry.end() ) {
     DEBMSG << "    registering IoComponent \"" << ioname << "\"" << endmsg;
     iocomponent->addRef(); // ownership...
     m_ioregistry[ioname] = iocomponent;
     m_iostack.push_back( iocomponent );
   } else {
     info() << "IoComponent[" << iocomponent->name() << "] already registered @" << (void*)itr->second << endmsg;
   }
   return StatusCode::SUCCESS;
 }

◆ io_register() [2/2]

StatusCode IoComponentMgr::io_register	(	IIoComponent *	iocomponent,
		IIoComponentMgr::IoMode::Type	iomode,
		const std::string &	fname,
		const std::string &	pfn
	)

override

: allow a IIoComponent to register itself with this manager so appropriate actions can be taken when e.g.

a fork(2) has been issued (this is usually handled by calling IIoComponent::io_reinit on every registered component)

Definition at line 173 of file IoComponentMgr.cpp.

                                                                                        {
   if ( 0 == iocomponent ) { return StatusCode::FAILURE; }
   const std::string& ioname = iocomponent->name();
  
   DEBMSG << "--> io_register(" << ioname << "," << ( ( iomode == IIoComponentMgr::IoMode::READ ) ? "R" : "W" ) << ","
          << fname << ")" << endmsg;
  
   if ( !io_hasitem( iocomponent ) ) {
     if ( !io_register( iocomponent ).isSuccess() ) {
       error() << "could not register component [" << iocomponent->name() << "] "
               << "with the I/O component manager !" << endmsg;
       return StatusCode::FAILURE;
     }
   }
  
   pair<iodITR, iodITR> fit = m_cdict.equal_range( iocomponent );
   if ( fit.first != fit.second ) {
     for ( iodITR it = fit.first; it != fit.second; ++it ) {
       IoComponentEntry ioe = it->second;
       if ( ioe.m_oldfname == fname ) {
         if ( ioe.m_iomode == iomode ) {
           info() << "IoComponent " << ioname << " has already had file " << fname << " registered with i/o mode "
                  << iomode << endmsg;
           return StatusCode::SUCCESS;
         } else {
           warning() << "IoComponent " << ioname << " has already had file " << fname
                     << " registered with a different i/o mode " << ioe.m_iomode << " - now trying " << iomode << endmsg;
         }
       }
     }
   }
  
   // We need to take into account that boost::filesystem::absolute() does not work with direct I/O inputs
   const std::string& tmp_name = ( pfn.empty() ? fname : pfn );
   bool               special_case =
       std::any_of( begin( m_directio_patterns.value() ), end( m_directio_patterns.value() ),
                    [&]( const std::string& pf ) { return boost::algorithm::contains( tmp_name, pf ); } );
   IoComponentEntry ioc( fname, ( special_case ? tmp_name : boost::filesystem::absolute( tmp_name ).string() ), iomode );
   m_cdict.insert( pair<IIoComponent*, IoComponentEntry>( iocomponent, ioc ) );
  
   return StatusCode::SUCCESS;
 }

◆ io_reinitialize()

StatusCode IoComponentMgr::io_reinitialize ( )

override

: reinitialize the I/O subsystem.

This effectively calls IIoComponent::io_reinit on all the registered IIoComponent.

Definition at line 273 of file IoComponentMgr.cpp.

                                            {
   ON_DEBUG {
     debug() << "--> io_reinitialize()" << endmsg;
     debug() << "reinitializing I/O subsystem..." << endmsg;
     debug() << "Listing all monitored entries: " << std::endl;
     debug() << list() << endmsg;
   }
  
   bool allgood = true;
   for ( auto& io : m_iostack ) {
     DEBMSG << " [" << io->name() << "]->io_reinit()..." << endmsg;
     if ( !io->io_reinit().isSuccess() ) {
       allgood = false;
       error() << "problem in [" << io->name() << "]->io_reinit() !" << endmsg;
     }
   }
  
   return allgood ? StatusCode::SUCCESS : StatusCode::FAILURE;
 }

◆ io_retrieve() [1/2]

std::vector< std::string > IoComponentMgr::io_retrieve ( IIoComponent * iocomponent )

override

: retrieve all registered filenames for a given IIoComponent

Definition at line 219 of file IoComponentMgr.cpp.

                                                                             {
   std::vector<std::string> fnames;
   pair<iodITR, iodITR>     pit;
  
   // Find component and copy all registered file names
   if ( iocomponent != nullptr && findComp( iocomponent, pit ) ) {
     std::transform( pit.first, pit.second, std::back_inserter( fnames ),
                     []( const auto& itr ) { return itr.second.m_oldfname; } );
   }
   return fnames;
 }

◆ io_retrieve() [2/2]

StatusCode IoComponentMgr::io_retrieve	(	IIoComponent *	iocomponent,
		std::string &	fname
	)

override

: retrieve the new filename for a given IIoComponent and

Parameters

<tt>fname</tt> filename

Definition at line 236 of file IoComponentMgr.cpp.

                                                                                     {
   if ( 0 == iocomponent ) { return StatusCode::FAILURE; }
  
   std::string        ofname = fname;
   const std::string& ioname = iocomponent->name();
  
   DEBMSG << "--> io_retrieve(" << ioname << "," << fname << ")" << endmsg;
  
   iodITR it;
   if ( !findComp( iocomponent, ofname, it ) ) {
     DEBMSG << "could not find c: " << ioname << "  old_f: " << ofname << endmsg;
     return StatusCode::FAILURE;
   } else {
  
     IoDict_t::iterator it;
     for ( it = m_cdict.equal_range( iocomponent ).first; it != m_cdict.equal_range( iocomponent ).second; ++it ) {
  
       if ( it->second.m_oldfname == ofname ) {
         DEBMSG << "retrieving new name for the component " << iocomponent->name() << " old name: " << ofname
                << ", new name: " << it->second.m_newfname << endmsg;
         fname = it->second.m_newfname;
         return StatusCode::SUCCESS;
       }
     }
   }
  
   DEBMSG << "Unexpected error! Unable to find entry in the dictionary corresponding to old filename: " << ofname
          << endmsg;
   return StatusCode::FAILURE;
 }

◆ io_update() [1/2]

StatusCode IoComponentMgr::io_update	(	IIoComponent *	iocomponent,
		const std::string &	old_fname,
		const std::string &	new_fname
	)

override

: allow a IIoComponent to update the contents of the registry with a new file name

Definition at line 295 of file IoComponentMgr.cpp.

                                                                                                                 {
  
   DEBMSG << "--> io_update(" << ioc->name() << "," << old_fname << "," << new_fname << ")" << endmsg;
  
   IoDict_t::iterator it;
   for ( it = m_cdict.equal_range( ioc ).first; it != m_cdict.equal_range( ioc ).second; ++it ) {
  
     if ( it->second.m_oldfname == old_fname ) {
       DEBMSG << "updating " << ioc->name() << " f: " << old_fname << " -> " << new_fname << endmsg;
       it->second.m_newfname = new_fname;
       return StatusCode::SUCCESS;
     }
   }
  
   return StatusCode::FAILURE;
 }

◆ io_update() [2/2]

StatusCode IoComponentMgr::io_update	(	IIoComponent *	iocomponent,
		const std::string &	work_dir
	)

override

: allow a IIoComponent to update the contents of the registry with a new work directory

Definition at line 314 of file IoComponentMgr.cpp.

                                                                                    {
  
   DEBMSG << "--> io_update(" << ioc->name() << "," << work_dir << ")" << endmsg;
  
   IoDict_t::iterator it;
   for ( it = m_cdict.equal_range( ioc ).first; it != m_cdict.equal_range( ioc ).second; ++it ) {
  
     switch ( it->second.m_iomode ) {
     case IIoComponentMgr::IoMode::READ: {
       it->second.m_newfname = it->second.m_oldabspath;
       break;
     }
     case IIoComponentMgr::IoMode::WRITE: {
       boost::filesystem::path oldPath( it->second.m_oldfname );
       if ( oldPath.is_relative() && oldPath.filename() == oldPath.relative_path() ) {
  
         // Only file name was provided for writing. This is the usual mode of operation
         // ***
         // NB. In such cases it would make sense to set newfname=oldfname, however this will break
         //     existing client codes, which assume that newfname contains "/"
         //     Thus we set newfname=workdir/oldfname
         // ***
  
         boost::filesystem::path newfname( work_dir );
         newfname /= oldPath;
         it->second.m_newfname = newfname.string();
       } else {
         // New name should be the old absolute path
         it->second.m_newfname = it->second.m_oldabspath;
       }
  
       break;
     }
     default: {
       // Don't know how to deal with either RW or INVALID
       error() << "Unable to update IoComponent for the mode " << it->second.m_iomode << endmsg;
       return StatusCode::FAILURE;
     }
     }
  
   } // for
  
   return StatusCode::SUCCESS;
 }

◆ io_update_all()

StatusCode IoComponentMgr::io_update_all ( const std::string & work_dir )

override

: Update all IIoComponents with a new work directory

Definition at line 361 of file IoComponentMgr.cpp.

                                                                     {
   DEBMSG << "-->io_update_all for the directory " << work_dir << endmsg;
   bool allgood = true;
   for ( IoStack_t::iterator io = m_iostack.begin(), ioEnd = m_iostack.end(); io != ioEnd; ++io ) {
     if ( !io_update( *io, work_dir ).isSuccess() ) {
       allgood = false;
       error() << "problem in [" << ( *io )->name() << "]->io_update() !" << endmsg;
     }
   }
   return allgood ? StatusCode::SUCCESS : StatusCode::FAILURE;
 }

◆ list()

std::string IoComponentMgr::list ( ) const

private

Definition at line 433 of file IoComponentMgr.cpp.

                                      {
  
   ostringstream ost;
  
   ost << "Listing all IoComponents (" << m_cdict.size() << "): " << endl;
   for ( const auto& i : m_cdict ) { ost << "  " << i.first->name() << "  " << i.second << endl; }
  
   return ost.str();
 }

Member Data Documentation

◆ m_cdict

IoDict_t IoComponentMgr::m_cdict

private

Definition at line 174 of file IoComponentMgr.h.

◆ m_dict_location

std::string IoComponentMgr::m_dict_location

private

location of the python dictionary

Definition at line 177 of file IoComponentMgr.h.

◆ m_directio_patterns

Gaudi::Property<std::vector<std::string> > IoComponentMgr::m_directio_patterns

private

Initial value:

{ this,
                                                                 "DirectIOPatterns",
                                                                 {
                                                                     "://",
                                                                 },
                                                                 "Search patterns for direct I/O input names" }

search patterns for special file names (direct I/O protocols)

Definition at line 180 of file IoComponentMgr.h.

◆ m_ioregistry

IoRegistry_t IoComponentMgr::m_ioregistry

private

Registry of IIoComponents.

Definition at line 164 of file IoComponentMgr.h.

◆ m_iostack

IoStack_t IoComponentMgr::m_iostack

private

Stack of IIoComponents to properly handle order of registration.

Definition at line 168 of file IoComponentMgr.h.

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

GaudiMP/src/component/IoComponentMgr.h
GaudiMP/src/component/IoComponentMgr.cpp

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IoDict_t

◆ iodITR

◆ IoRegistry_t

◆ IoStack_t

Constructor & Destructor Documentation

◆ IoComponentMgr()

Member Function Documentation

◆ finalize()

◆ findComp() [1/3]

◆ findComp() [2/3]

◆ findComp() [3/3]

◆ handle()

◆ initialize()

◆ io_contains()

◆ io_finalize()

◆ io_hasitem()

◆ io_register() [1/2]

◆ io_register() [2/2]

◆ io_reinitialize()

◆ io_retrieve() [1/2]

◆ io_retrieve() [2/2]

◆ io_update() [1/2]

◆ io_update() [2/2]

◆ io_update_all()

◆ list()

Member Data Documentation

◆ m_cdict

◆ m_dict_location

◆ m_directio_patterns

◆ m_ioregistry

◆ m_iostack