TRawFile Class Reference

Reader for raw files.

This Class is used to read and write raw files in the root framework.

Definition at line 31 of file TRawFile.h.

Public Types
enum	EOpenType { EOpenType::kRead, EOpenType::kWrite }

Public Member Functions
	TRawFile ()
	TRawFile (const char *, EOpenType=EOpenType::kRead)
	~TRawFile () override=default
virtual void	Close ()=0
virtual size_t	GetBytesRead ()
virtual const char *	GetFilename () const
virtual size_t	GetFileSize ()
virtual std::shared_ptr< TRawEvent >	GetOdbEvent ()
virtual int	GetRunNumber ()=0
virtual int	GetSubRunNumber ()=0
virtual std::shared_ptr< TRawEvent >	NewEvent ()=0
virtual bool	Open (const char *filename)=0
virtual int	Read (std::shared_ptr< TRawEvent > event)=0
virtual void	Skip (size_t nofEvents)=0
virtual std::string	Status (bool long_file_description=true)=0

Protected Attributes
size_t	fBytesRead {0}
std::string	fFilename
size_t	fFileSize {0}
std::vector< char >	fReadBuffer

#include <TRawFile.h>

Inheritance diagram for TRawFile:

Collaboration diagram for TRawFile:

Member Enumeration Documentation

EOpenType

enum TRawFile::EOpenType

strong

Enumerator
kRead
kWrite

Definition at line 33 of file TRawFile.h.

Constructor & Destructor Documentation

TRawFile() [1/2]

TRawFile::TRawFile ( )

inline

default constructor

Definition at line 35 of file TRawFile.h.

TRawFile() [2/2]

TRawFile::TRawFile ( const char *  , EOpenType  = EOpenType::kRead  )

inline

Definition at line 36 of file TRawFile.h.

~TRawFile()

TRawFile::~TRawFile ( )

overridedefault

destructor

Member Function Documentation

Close()

virtual void TRawFile::Close ( )

pure virtual

Close input file.

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

GetBytesRead()

virtual size_t TRawFile::GetBytesRead ( )

inlinevirtual

Definition at line 56 of file TRawFile.h.

References fBytesRead.

Referenced by TDataLoop::Iteration().

GetFilename()

virtual const char* TRawFile::GetFilename ( ) const

inlinevirtual

Get the name of this file.

Reimplemented in TMidasFile.

Definition at line 51 of file TRawFile.h.

References fFilename.

Referenced by TLstFile::Open(), TTdrFile::Open(), and TRlmdFile::Open().

GetFileSize()

virtual size_t TRawFile::GetFileSize ( )

inlinevirtual

Definition at line 57 of file TRawFile.h.

References fFileSize.

Referenced by TDataLoop::Iteration().

GetOdbEvent()

virtual std::shared_ptr<TRawEvent> TRawFile::GetOdbEvent ( )

inlinevirtual

Reimplemented in TMidasFile.

Definition at line 60 of file TRawFile.h.

GetRunNumber()

virtual int TRawFile::GetRunNumber ( )

pure virtual

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

GetSubRunNumber()

virtual int TRawFile::GetSubRunNumber ( )

pure virtual

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

NewEvent()

virtual std::shared_ptr<TRawEvent> TRawFile::NewEvent ( )

pure virtual

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

Referenced by TDataLoop::Iteration().

Open()

virtual bool TRawFile::Open ( const char *  filename )

pure virtual

Open input file.

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

Read()

virtual int TRawFile::Read ( std::shared_ptr< TRawEvent >  event )

pure virtual

Read one event from the file.

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

Referenced by TDataLoop::Iteration().

Skip()

virtual void TRawFile::Skip ( size_t  nofEvents )

pure virtual

Skip nofEvents events in file.

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

Referenced by TDataLoop::Iteration().

Status()

virtual std::string TRawFile::Status ( bool  long_file_description = true )

pure virtual

Implemented in TRlmdFile, TMidasFile, TTdrFile, and TLstFile.

Member Data Documentation

fBytesRead

size_t TRawFile::fBytesRead {0}

protected

Definition at line 69 of file TRawFile.h.

Referenced by TRlmdFile::Close(), GetBytesRead(), TRlmdFile::Open(), TLstFile::Read(), TTdrFile::Read(), TMidasFile::Read(), TRlmdFile::Read(), TTdrFile::Skip(), TMidasFile::Skip(), TLstFile::Status(), TTdrFile::Status(), and TMidasFile::Status().

fFilename

std::string TRawFile::fFilename

protected

name of the currently open file

Definition at line 65 of file TRawFile.h.

Referenced by TMidasFile::Close(), GetFilename(), TMidasFile::GetFilename(), TLstFile::GetRunNumber(), TTdrFile::GetRunNumber(), TMidasFile::GetRunNumber(), TRlmdFile::GetRunNumber(), TTdrFile::GetSubRunNumber(), TMidasFile::GetSubRunNumber(), TLstFile::Open(), TTdrFile::Open(), TMidasFile::Open(), and TRlmdFile::Open().

fFileSize

size_t TRawFile::fFileSize {0}

protected

Definition at line 70 of file TRawFile.h.

Referenced by TRlmdFile::Close(), GetFileSize(), TLstFile::Open(), TMidasFile::Open(), TTdrFile::Open(), TRlmdFile::Open(), TLstFile::Read(), TTdrFile::Read(), TRlmdFile::Read(), TTdrFile::Skip(), TLstFile::Status(), TTdrFile::Status(), TMidasFile::Status(), and TRlmdFile::Status().

fReadBuffer

std::vector<char> TRawFile::fReadBuffer

protected

Definition at line 67 of file TRawFile.h.

Referenced by TLstFile::Open(), TTdrFile::Open(), TLstFile::Read(), TTdrFile::Read(), TMidasFile::Read(), TRlmdFile::Read(), TMidasFile::ReadMoreBytes(), and TMidasFile::Skip().