FileReadTool Class Reference

Basic implementation of the IFileAccess interface. More...

Inheritance diagram for FileReadTool:

Collaboration diagram for FileReadTool:

Public Member Functions
std::unique_ptr< std::istream >	open (std::string const &url) override
const std::vector< std::string > &	protocols () const override
	Protocols supported by the instance.
Public Member Functions inherited from extends< AlgTool, IFileAccess >
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 AlgTool
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface.
void const *	i_cast (const InterfaceID &riid) const override
const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object.
const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool.
const IInterface *	parent () const override
	Retrieve parent of the sub-algtool.
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
StatusCode	reinitialize () override
StatusCode	restart () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	sysInitialize () override
	Initialize AlgTool.
StatusCode	sysStart () override
	Start AlgTool.
StatusCode	sysStop () override
	Stop AlgTool.
StatusCode	sysFinalize () override
	Finalize AlgTool.
StatusCode	sysReinitialize () override
	Initialize AlgTool.
StatusCode	sysRestart () override
	Start AlgTool.
	AlgTool (std::string type, std::string name, const IInterface *parent)
	Standard Constructor.
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.
ISvcLocator *	svcLoc () const
	shortcut for the method service locator
IDataProviderSvc *	evtSvc () const
	accessor to event service service
IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.
SmartIF< IService >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name")
template<typename T>
SmartIF< T >	service (std::string_view name, const bool createIf=true, const bool quiet=false) 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)
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)
void	acceptDHVisitor (IDataHandleVisitor *) const override
void	registerTool (IAlgTool *tool) const
void	deregisterTool (IAlgTool *tool) const
const std::vector< IAlgTool * > &	tools () const
IAuditorSvc *	auditorSvc () const
	Access the auditor service.
IMonitorSvc *	monitorSvc () const
	Access the monitor service.
template<class T>
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information.
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case)
	~AlgTool () override
Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override
std::vector< Gaudi::DataHandle * >	outputHandles () const override
virtual const DataObjIDColl &	extraInputDeps () const override
virtual const DataObjIDColl &	extraOutputDeps () const override
void	declare (Gaudi::DataHandle &handle) override
void	renounce (Gaudi::DataHandle &handle) override
bool	renounceInput (const DataObjID &id) override
const DataObjIDColl &	inputDataObjs () const override
const DataObjIDColl &	outputDataObjs () const override
void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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 PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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< IAlgTool, IDataHandleHolder, 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)

Additional Inherited Members
Public Types inherited from extends< AlgTool, IFileAccess >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from AlgTool
using	Factory = Gaudi::PluginService::Factory<IAlgTool*( const std::string&, const std::string&, const IInterface* )>
Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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 AlgTool
template<typename I>
void	declareInterface (I *i)
std::vector< IAlgTool * > &	tools ()
Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this
Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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 AlgTool
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.
Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs
DataObjIDColl	m_outputDataObjs

Detailed Description

Basic implementation of the IFileAccess interface.

This tool simply takes a path to a file as url and return the std::istream interface of std::ifstream.

Author

Marco Clemencic

Date

2008-01-18

Definition at line 24 of file FileReadTool.cpp.

Member Function Documentation

open()

std::unique_ptr< std::istream > FileReadTool::open ( std::string const & url )

inlineoverride

Definition at line 28 of file FileReadTool.cpp.

                                                                  {
    // remove the optional "file://" from the beginning of the url
    constexpr auto prefix = std::string_view{ "file://" };
    return std::make_unique<std::ifstream>( url.compare( 0, prefix.size(), prefix ) == 0 ? url.substr( prefix.size() )
                                                                                         : url );
  }

protocols()

const std::vector< std::string > & FileReadTool::protocols ( ) const

inlineoverride

Protocols supported by the instance.

Vector of supported protocols.

Definition at line 36 of file FileReadTool.cpp.

                                                         {
    static const std::vector<std::string> s_protocols = { { "file" } };
    return s_protocols;
  }

---

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

• GaudiUtils/src/component/FileReadTool.cpp