Gaudi Framework, version v24r2

Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Public Member Functions | List of all members
IIoComponentMgr Class Referenceabstract

#include <IIoComponentMgr.h>

Inheritance diagram for IIoComponentMgr:
Inheritance graph
[legend]
Collaboration diagram for IIoComponentMgr:
Collaboration graph
[legend]

Classes

struct  IoMode
 

Public Member Functions

 DeclareInterfaceID (IIoComponentMgr, 1, 0)
 
virtual ~IIoComponentMgr ()
 Destructor:
 
virtual StatusCode io_register (IIoComponent *iocomponent)=0
 : allow a IIoComponent to register itself with this manager so appropriate actions can be taken when e.g.
 
virtual StatusCode io_register (IIoComponent *iocomponent, IIoComponentMgr::IoMode::Type iomode, const std::string &fname, const std::string &pfn="")=0
 : allow a IIoComponent to register itself with this manager so appropriate actions can be taken when e.g.
 
virtual StatusCode io_update (IIoComponent *iocomponent, const std::string &old_fname, const std::string &new_fname)=0
 : allow a IIoComponent to update the contents of the registry with a new file name
 
virtual StatusCode io_update (IIoComponent *iocomponent, const std::string &work_dir)=0
 : allow a IIoComponent to update the contents of the registry with a new work directory
 
virtual StatusCode io_update_all (const std::string &work_dir)=0
 : Update all IIoComponents with a new work directory
 
virtual bool io_hasitem (IIoComponent *iocomponent) const =0
 : check if the registry contains a given IIoComponent
 
virtual bool io_contains (IIoComponent *iocomponent, const std::string &fname) const =0
 : check if the registry contains a given IIoComponent and that component had
 
virtual StatusCode io_retrieve (IIoComponent *iocomponent, std::string &fname)=0
 : retrieve the new filename for a given IIoComponent and
 
virtual StatusCode io_reinitialize ()=0
 : reinitialize the I/O subsystem.
 
virtual StatusCode io_finalize ()=0
 : finalize the I/O subsystem.
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID.
 
virtual const std::stringname () const =0
 Retrieve the name of the instance.
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes).
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
 
virtual unsigned long release ()=0
 Release Interface instance.
 
virtual unsigned long refCount () const =0
 Current reference count.
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
 
virtual ~IInterface ()
 Virtual destructor.
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
typedef Gaudi::InterfaceId
< IInterface, 0, 0 > 
iid
 Interface ID.
 
typedef mpl::set1< iidext_iids
 Extra interfaces.
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 

Detailed Description

Definition at line 22 of file IIoComponentMgr.h.

Constructor & Destructor Documentation

IIoComponentMgr::~IIoComponentMgr ( )
virtual

Destructor:

Definition at line 31 of file VirtualDestructors.cpp.

{}

Member Function Documentation

IIoComponentMgr::DeclareInterfaceID ( IIoComponentMgr  ,
,
 
)
virtual bool IIoComponentMgr::io_contains ( IIoComponent iocomponent,
const std::string fname 
) const
pure virtual

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

Parameters
<tt>fname</tt>as a filename
virtual StatusCode IIoComponentMgr::io_finalize ( )
pure virtual

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

virtual bool IIoComponentMgr::io_hasitem ( IIoComponent iocomponent) const
pure virtual

: check if the registry contains a given IIoComponent

virtual StatusCode IIoComponentMgr::io_register ( IIoComponent iocomponent)
pure virtual

: 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)

virtual StatusCode IIoComponentMgr::io_register ( IIoComponent iocomponent,
IIoComponentMgr::IoMode::Type  iomode,
const std::string fname,
const std::string pfn = "" 
)
pure virtual

: 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)

virtual StatusCode IIoComponentMgr::io_reinitialize ( )
pure virtual

: reinitialize the I/O subsystem.

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

virtual StatusCode IIoComponentMgr::io_retrieve ( IIoComponent iocomponent,
std::string fname 
)
pure virtual

: retrieve the new filename for a given IIoComponent and

Parameters
<tt>fname</tt>filename
virtual StatusCode IIoComponentMgr::io_update ( IIoComponent iocomponent,
const std::string old_fname,
const std::string new_fname 
)
pure virtual

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

virtual StatusCode IIoComponentMgr::io_update ( IIoComponent iocomponent,
const std::string work_dir 
)
pure virtual

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

virtual StatusCode IIoComponentMgr::io_update_all ( const std::string work_dir)
pure virtual

: Update all IIoComponents with a new work directory


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

Generated at Wed Dec 4 2013 14:33:17 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004