Detailed Description

Read Google Protobuf DAQ files.

Created by KVClassFactory on Mon Jan 14 12:10:22 2019 Author: John Frankland,,,

Definition at line 15 of file KVProtobufDataReader.h.

#include <KVProtobufDataReader.h>

Inheritance diagram for KVProtobufDataReader:

[legend]

Public Member Functions
	KVProtobufDataReader (const Char_t filepath, Int_t bufSiz=16 1024 *1024)

	KVProtobufDataReader (Int_t bufSiz=16 1024 1024)
	Create file reader of given buffer size, do not open any files yet.

virtual	~KVProtobufDataReader ()
	Destructor.

TString	GetDataFormat () const

Bool_t	GetNextEvent ()

Int_t	GetRunNumberReadFromFile () const

Public Member Functions inherited from KVRawDataReader
	KVRawDataReader ()
	Default constructor.

virtual	~KVRawDataReader ()
	Destructor.

const KVNameValueList &	GetRunInfos () const

virtual Int_t	GetStatus () const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor.

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type.

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label.

virtual void	Copy (TObject &) const
	Make a copy of this object.

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator

virtual void	Print (Option_t *option="") const

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

void	Clear (Option_t *option="") override

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

void	Print (Option_t *option="") const override

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Private Member Functions
UInt_t	get_remaining_readable_buffer () const

void	open_file (const Char_t *filepath)

virtual bool	parse_event_from_message ()=0

virtual bool	read_buffer ()
	read a buffer from the file

Private Attributes
char *	fBuffer
	current buffer

Int_t	fBufSize
	buffer size

ptrdiff_t	fEvOffset
	next position to read in buffer

UInt_t	fEvSize
	size of next event in buffer

std::unique_ptr< TFile >	fFile
	TFile plugin handle.

Long64_t	fFileSize
	size of file in bytes

bool	fNeedToReadBuffer
	true when the buffer is empty/incomplete

bool	fReachedEndOfFile
	true when we have read all bytes from file

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Static Public Member Functions inherited from KVRawDataReader
static KVRawDataReader *	OpenFile (const TString &type, const TString &filename)

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values.

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date.

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build.

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time.

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build.

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build.

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string.

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources.

static const Char_t *	gitCommit ()
	Returns last git commit of sources.

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc.

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

◆ KVProtobufDataReader() [1/2]

KVProtobufDataReader::KVProtobufDataReader ( Int_t bufSiz = 16 * 1024 * 1024 )

Create file reader of given buffer size, do not open any files yet.

Definition at line 164 of file KVProtobufDataReader.cpp.

◆ KVProtobufDataReader() [2/2]

KVProtobufDataReader::KVProtobufDataReader	(	const Char_t *	filepath,
		Int_t	bufSiz = `16 * 1024 * 1024`
	)

Open Google protobuf file for reading. Filepath URL will be passed to TFile::Open therefore can use same plugins eg. "root://" etc. Default buffer size: 16MB Note: buffer size given as Int_t, as this is argument type required by TFile::ReadBuffer

Definition at line 146 of file KVProtobufDataReader.cpp.

◆ ~KVProtobufDataReader()

KVProtobufDataReader::~KVProtobufDataReader ( )

virtual

Destructor.

Definition at line 177 of file KVProtobufDataReader.cpp.

Member Function Documentation

◆ get_remaining_readable_buffer()

UInt_t KVProtobufDataReader::get_remaining_readable_buffer ( ) const

inlineprivate

number of bytes remaining to read in buffer starting from current position fEvOffset

Definition at line 28 of file KVProtobufDataReader.h.

◆ GetDataFormat()

TString KVProtobufDataReader::GetDataFormat ( ) const

inlinevirtual

Implements KVRawDataReader.

Definition at line 45 of file KVProtobufDataReader.h.

◆ GetNextEvent()

Bool_t KVProtobufDataReader::GetNextEvent ( )

virtual

Prepare to read next event in buffer.

if a new buffer is needed, we read one from the file
at current position in buffer we read the size of the next protobuf message
we check if the entire message is contained within the buffer if not, the part of the message already read is moved to the start of the buffer then the rest of the buffer is filled from the file
if this method returns true, then fEvOffset and fEvSize are correctly positioned in order for the message to be read (handled by daughter class with specific protobuf message format)
if this method returns false, then either a major problem occurred when reading the file, or we have reached the end and there are no more events/messages to read

Implements KVRawDataReader.

Definition at line 26 of file KVProtobufDataReader.cpp.

◆ GetRunNumberReadFromFile()

Int_t KVProtobufDataReader::GetRunNumberReadFromFile ( ) const

virtual

Implements KVRawDataReader.

Definition at line 190 of file KVProtobufDataReader.cpp.

◆ open_file()

void KVProtobufDataReader::open_file ( const Char_t * filepath )

private

Definition at line 121 of file KVProtobufDataReader.cpp.

◆ parse_event_from_message()

virtual bool KVProtobufDataReader::parse_event_from_message ( )

privatepure virtual

Implemented in KVFzDataReader.

◆ read_buffer()

bool KVProtobufDataReader::read_buffer ( )

privatevirtual

read a buffer from the file

Reimplemented in KVFzDataReader.

Definition at line 87 of file KVProtobufDataReader.cpp.

Member Data Documentation

◆ fBuffer

char* KVProtobufDataReader::fBuffer

private

current buffer

Definition at line 18 of file KVProtobufDataReader.h.

◆ fBufSize

Int_t KVProtobufDataReader::fBufSize

private

buffer size

Definition at line 17 of file KVProtobufDataReader.h.

◆ fEvOffset

ptrdiff_t KVProtobufDataReader::fEvOffset

private

next position to read in buffer

Definition at line 22 of file KVProtobufDataReader.h.

◆ fEvSize

UInt_t KVProtobufDataReader::fEvSize

private

size of next event in buffer

Definition at line 21 of file KVProtobufDataReader.h.

◆ fFile

std::unique_ptr<TFile> KVProtobufDataReader::fFile

private

TFile plugin handle.

Definition at line 19 of file KVProtobufDataReader.h.

◆ fFileSize

Long64_t KVProtobufDataReader::fFileSize

private

size of file in bytes

Definition at line 20 of file KVProtobufDataReader.h.

◆ fNeedToReadBuffer

bool KVProtobufDataReader::fNeedToReadBuffer

private

true when the buffer is empty/incomplete

Definition at line 23 of file KVProtobufDataReader.h.

◆ fReachedEndOfFile

bool KVProtobufDataReader::fReachedEndOfFile

private

true when we have read all bytes from file

Definition at line 24 of file KVProtobufDataReader.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVProtobufDataReader() [1/2]

◆ KVProtobufDataReader() [2/2]

◆ ~KVProtobufDataReader()

Member Function Documentation

◆ get_remaining_readable_buffer()

◆ GetDataFormat()

◆ GetNextEvent()

◆ GetRunNumberReadFromFile()

◆ open_file()

◆ parse_event_from_message()

◆ read_buffer()

Member Data Documentation

◆ fBuffer

◆ fBufSize

◆ fEvOffset

◆ fEvSize

◆ fFile

◆ fFileSize

◆ fNeedToReadBuffer

◆ fReachedEndOfFile