FileReadTool Class Reference

Basic implementation of the IFileAccess interface. More...

#include <FileReadTool.h>

Inheritance diagram for FileReadTool:

Collaboration diagram for FileReadTool:

Public Member Functions
	FileReadTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual	~FileReadTool ()
virtual std::auto_ptr < std::istream >	open (const std::string &url)
	Find the URL and returns an auto_ptr to an input stream interface of an object that can be used to read from the file the URL is pointing to.
virtual const std::vector < std::string > &	protocols () const
	Protocols supported by the instance.
Public Member Functions inherited from extends1< AlgTool, IFileAccess >
	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments.
	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments.
	extends1 (A1 a1)
	Templated constructor with 1 argument.
	extends1 ()
	Default constructor.
virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface.
virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames.
virtual	~extends1 ()
	Virtual destructor.
Public Member Functions inherited from AlgTool
virtual const std::string &	name () const
	Retrieve full identifying name of the concrete tool object.
virtual const std::string &	type () const
	Retrieve type (concrete class) of the sub-algtool.
virtual const IInterface *	parent () const
	Retrieve parent of the sub-algtool.
virtual StatusCode	configure ()
virtual StatusCode	initialize ()
virtual StatusCode	start ()
virtual StatusCode	stop ()
virtual StatusCode	finalize ()
virtual StatusCode	terminate ()
virtual StatusCode	reinitialize ()
virtual StatusCode	restart ()
virtual Gaudi::StateMachine::State	FSMState () const
virtual Gaudi::StateMachine::State	targetFSMState () const
virtual StatusCode	sysInitialize ()
	Initialize AlgTool.
virtual StatusCode	sysStart ()
	Start AlgTool.
virtual StatusCode	sysStop ()
	Stop AlgTool.
virtual StatusCode	sysFinalize ()
	Finalize AlgTool.
virtual StatusCode	sysReinitialize ()
	Initialize AlgTool.
virtual StatusCode	sysRestart ()
	Start AlgTool.
virtual StatusCode	setProperty (const Property &p)
	Default implementations for IProperty interface.
virtual StatusCode	setProperty (const std::string &s)
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
virtual StatusCode	getProperty (Property *p) const
virtual const Property &	getProperty (const std::string &name) const
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
virtual const std::vector < Property * > &	getProperties () const
PropertyMgr *	getPropertyMgr ()
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value
	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
ISvcLocator *	serviceLocator () const
	Retrieve pointer to service locator.
ISvcLocator *	svcLoc () const
	shortcut for the method service locator
IMessageSvc *	msgSvc () const
	Retrieve pointer to message service.
IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.
StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service.
template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist.
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&svc) const
	Access a service by name, type creating it if it doesn't already exist.
SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name")
void	declInterface (const InterfaceID &, void *)
	declare interface
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property.
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties.
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)
Public Member Functions inherited from extend_interfaces1< IFileAccess >
virtual	~extend_interfaces1 ()
	Virtual destructor.
Public Member Functions inherited from IFileAccess
	DeclareInterfaceID (IFileAccess, 2, 0)
	InterfaceID.
virtual	~IFileAccess ()
Public Member Functions inherited from IInterface
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	~IInterface ()
	Virtual destructor.

Private Attributes
std::vector< std::string >	m_protocols
	Vector of supported protocols.

Additional Inherited Members
Public Types inherited from extends1< AlgTool, IFileAccess >
typedef extends1	base_class
	Typedef to this class.
typedef extend_interfaces1 < IFileAccess >	extend_interfaces_base
	Typedef to the base of this class.
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from AlgTool
int	outputLevel () const
	get tool's output level
IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property.
void	initOutputLevel (Property &prop)
	callback for output level property
virtual	~AlgTool ()

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 17 of file FileReadTool.h.

Constructor & Destructor Documentation

FileReadTool::FileReadTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

Definition at line 7 of file FileReadTool.cpp.

                                                     :
  base_class(type, name, parent)
{
  //declareInterface<IFileAccess>(this);
  m_protocols.push_back("file");