Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

IOfileVI Class Reference

virtual inteface to handle a file with persistency data. More...

#include <IOfileVI.h>

Inheritance diagram for IOfileVI:

List of all members.

Public Methods

IOfileVI ()

default constructor.

virtual ~IOfileVI ()

default destructor.

virtual void setFileName (std::string name)

set the name of the file.

virtual void setMode (IOBase::MODE m)

set the mode.

virtual void setNumEvents (int nevt)

set total number of events.

virtual void setOpen (bool t)

set the file to Open.

virtual void increase ()

virtual method to increase one event.

virtual void open () = 0

virtual method to open the file.

virtual void close () = 0

virtual method to close the file.

virtual bool nextEvent ()

virtual method to know if there is one event more in the file.

virtual void readEvent ()

virtual method to read the next event - overwrite by the derived class.

virtual void writeEvent ()

virtual method to write an event - overwrite by the derived class.

virtual void skipEvent ()

virtual method to skip next event - overwrite by the derived class.

virtual std::string getFileName () const

returns the name of the file.

IOBase::MODE getMode () const

returns the mode READ or WRITE.

virtual int eventNumber () const

virtual method to return the current Event.

virtual int numEvents () const

virtual method ro return the total number of events;.

virtual bool isOpen () const

virtual method to know if the file is open or not.

Protected Methods

virtual void clear ()

clear all the variables.

Private Attributes

std::string m_nameFile

name of the file.

IOBase::MODE m_mode

mode of open the file READ or WRITE.

bool m_open

is the file open?

int m_numEvents

number of total events in the file.

int m_currentEvent

the current event number.

Detailed Description

virtual inteface to handle a file with persistency data.

It handles the open(), close() of files. It knows if the file are type MODE READ or WRITE (see enumeration in IOBase).
It handles the readEvent(), writeEvent() and skipEvent() processes
It keeps contability of the number of events in the file (numEvents()), and number of event read or writen (eventNumber()).

Definition at line 24 of file IOfileVI.h.

Constructor & Destructor Documentation

IOfileVI::IOfileVI ( ) [inline]

default constructor.

Definition at line 30 of file IOfileVI.h.

IOfileVI::~IOfileVI ( ) [inline, virtual]

default destructor.

Definition at line 32 of file IOfileVI.h.

Member Function Documentation

void IOfileVI::clear ( ) [inline, protected, virtual]

clear all the variables.

Reimplemented in rTFileBase, and rTreeBase.

Definition at line 5 of file IOfileVI.cpp.

void IOfileVI::close ( ) [inline, pure virtual]

virtual method to close the file.

Reimplemented in IOfileNull, IOfileServer, and rTFileBase.

int IOfileVI::eventNumber ( ) const [inline, virtual]

virtual method to return the current Event.

Definition at line 64 of file IOfileVI.h.

std::string IOfileVI::getFileName ( ) const [inline, virtual]

returns the name of the file.

Definition at line 60 of file IOfileVI.h.

IOBase::MODE IOfileVI::getMode ( ) const [inline]

returns the mode READ or WRITE.

Definition at line 62 of file IOfileVI.h.

void IOfileVI::increase ( ) [inline, virtual]

virtual method to increase one event.

Definition at line 43 of file IOfileVI.h.

bool IOfileVI::isOpen ( ) const [inline, virtual]

virtual method to know if the file is open or not.

Definition at line 68 of file IOfileVI.h.

bool IOfileVI::nextEvent ( ) [inline, virtual]

virtual method to know if there is one event more in the file.

Reimplemented in IOfileServer.

Definition at line 51 of file IOfileVI.h.

int IOfileVI::numEvents ( ) const [inline, virtual]

virtual method ro return the total number of events;.

Definition at line 66 of file IOfileVI.h.

void IOfileVI::open ( ) [inline, pure virtual]

virtual method to open the file.

Reimplemented in IOfileNull, IOfileServer, rHistoFileServer, rTFileBase, and rTreeBase.

void IOfileVI::readEvent ( ) [inline, virtual]

virtual method to read the next event - overwrite by the derived class.

Reimplemented in IOfileServer, and rTreeBase.

Definition at line 53 of file IOfileVI.h.

void IOfileVI::setFileName ( std::string name ) [inline, virtual]

set the name of the file.

Definition at line 35 of file IOfileVI.h.

void IOfileVI::setMode ( IOBase::MODE m ) [inline, virtual]

set the mode.

Definition at line 37 of file IOfileVI.h.

void IOfileVI::setNumEvents ( int nevt ) [inline, virtual]

set total number of events.

Definition at line 39 of file IOfileVI.h.

void IOfileVI::setOpen ( bool t ) [inline, virtual]

set the file to Open.

Definition at line 41 of file IOfileVI.h.

void IOfileVI::skipEvent ( ) [inline, virtual]

virtual method to skip next event - overwrite by the derived class.

Reimplemented in IOfileServer, and rTreeBase.

Definition at line 57 of file IOfileVI.h.

void IOfileVI::writeEvent ( ) [inline, virtual]

virtual method to write an event - overwrite by the derived class.

Reimplemented in IOfileServer, and rTreeBase.

Definition at line 55 of file IOfileVI.h.

Member Data Documentation

int IOfileVI::m_currentEvent [private]

the current event number.

Definition at line 87 of file IOfileVI.h.

IOBase::MODE IOfileVI::m_mode [private]

mode of open the file READ or WRITE.

Definition at line 80 of file IOfileVI.h.

std::string IOfileVI::m_nameFile [private]

name of the file.

Definition at line 78 of file IOfileVI.h.

int IOfileVI::m_numEvents [private]

number of total events in the file.

Definition at line 85 of file IOfileVI.h.

bool IOfileVI::m_open [private]

is the file open?

Definition at line 82 of file IOfileVI.h.

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

Generated at Fri Aug 18 12:57:40 2000 for centella framework by

Public Methods
	IOfileVI ()
	default constructor.
virtual	~IOfileVI ()
	default destructor.
virtual void	setFileName (std::string name)
	set the name of the file.
virtual void	setMode (IOBase::MODE m)
	set the mode.
virtual void	setNumEvents (int nevt)
	set total number of events.
virtual void	setOpen (bool t)
	set the file to Open.
virtual void	increase ()
	virtual method to increase one event.
virtual void	open () = 0
	virtual method to open the file.
virtual void	close () = 0
	virtual method to close the file.
virtual bool	nextEvent ()
	virtual method to know if there is one event more in the file.
virtual void	readEvent ()
	virtual method to read the next event - overwrite by the derived class.
virtual void	writeEvent ()
	virtual method to write an event - overwrite by the derived class.
virtual void	skipEvent ()
	virtual method to skip next event - overwrite by the derived class.
virtual std::string	getFileName () const
	returns the name of the file.
IOBase::MODE	getMode () const
	returns the mode READ or WRITE.
virtual int	eventNumber () const
	virtual method to return the current Event.
virtual int	numEvents () const
	virtual method ro return the total number of events;.
virtual bool	isOpen () const
	virtual method to know if the file is open or not.
Protected Methods
virtual void	clear ()
	clear all the variables.
Private Attributes
std::string	m_nameFile
	name of the file.
IOBase::MODE	m_mode
	mode of open the file READ or WRITE.
bool	m_open
	is the file open?
int	m_numEvents
	number of total events in the file.
int	m_currentEvent
	the current event number.