RawFile Class Reference

#include <RawFile.h>

Public Member Functions
int	close ()
	Close file if necessary. More...
int	eof ()
	Check end of file. More...
bool	fail ()
	It is not OK. More...
FILE *	GetPointer ()
	Get file pointer. More...
int	ignore (long offset)
	Ignore some bytes. More...
bool	isRFIO ()
	Castor flag. More...
bool	isXROOTD ()
	XROOTD flag. More...
bool	ok ()
	It is OK (i.e. file was correctly opened) More...
RawFile *	open (const char *path)
	Open file. More...
	RawFile ()
	Default constructor. More...
	RawFile (const char *path)
	Usual constructor. More...
int	read (void *data, size_t nbytes)
	Read from file. More...
int	seek (long offset, int whence)
	Go somewhere. More...
long	tell ()
	Tell instruction. More...
virtual	~RawFile ()
	Destructor. More...

Private Attributes
FILE *	inputFile
bool	xrootdFlag

Detailed Description

Utility class to open, read and manage local and rfio files in a transparent way

Author

J. Alcaraz - CIEMAT, Madrid

Definition at line 14 of file RawFile.h.

Constructor & Destructor Documentation

RawFile() [1/2]

RawFile::RawFile

(

)

Default constructor.

Definition at line 15 of file RawFile.cc.

: inputFile(nullptr), xrootdFlag(false) {}

RawFile() [2/2]

RawFile::RawFile

(

const char *

path

)

Usual constructor.

Definition at line 17 of file RawFile.cc.

References open(), and castor_dqm_sourceclient_file_cfg::path.

: inputFile(nullptr), xrootdFlag(false) { open(path); }

~RawFile()

RawFile::~RawFile ( )

virtual

Destructor.

Definition at line 66 of file RawFile.cc.

References close().

{ close(); }

Member Function Documentation

close()

int RawFile::close

(

void

)

Close file if necessary.

Definition at line 52 of file RawFile.cc.

References RemoveAddSevLevel::flag, inputFile, and xrootdFlag.

Referenced by esMonitoring.AsyncLineReaderMixin::handle_close(), esMonitoring.FDJsonServer::handle_close(), DTDDUFileReader::~DTDDUFileReader(), DTNewROS8FileReader::~DTNewROS8FileReader(), DTROS25FileReader::~DTROS25FileReader(), DTROS8FileReader::~DTROS8FileReader(), and ~RawFile().

                   {
  int flag = -1;
  if (!inputFile)
    return flag;

  if (xrootdFlag) {
    flag = XrdPosix_Fclose(inputFile);
  } else {
    flag = fclose(inputFile);
  }
  inputFile = nullptr;
  return flag;
}

eof()

int RawFile::eof

(

)

Check end of file.

Definition at line 94 of file RawFile.cc.

References inputFile.

Referenced by DTNewROS8FileReader::checkEndOfFile(), DTROS8FileReader::checkEndOfFile(), DTROS25FileReader::checkEndOfFile(), and DTDDUFileReader::checkEndOfFile().

                 {
  return feof(inputFile);  // Also for XROOTD
}

fail()

bool RawFile::fail

(

)

It is not OK.

Definition at line 72 of file RawFile.cc.

References ok().

Referenced by DTDDUFileReader::DTDDUFileReader(), DTNewROS8FileReader::DTNewROS8FileReader(), DTROS25FileReader::DTROS25FileReader(), and DTROS8FileReader::DTROS8FileReader().

{ return !ok(); }

GetPointer()

FILE * RawFile::GetPointer

(

)

Get file pointer.

Definition at line 68 of file RawFile.cc.

References inputFile.

{ return inputFile; }

ignore()

int RawFile::ignore

(

long

offset

)

Ignore some bytes.

Definition at line 92 of file RawFile.cc.

References hltrates_dqm_sourceclient-live_cfg::offset, and seek().

Referenced by DTDDUFileReader::DTDDUFileReader().

{ return seek(offset, SEEK_CUR); }

isRFIO()

bool RawFile::isRFIO

(

)

Castor flag.

isXROOTD()

bool RawFile::isXROOTD

(

)

XROOTD flag.

Definition at line 74 of file RawFile.cc.

References xrootdFlag.

{ return xrootdFlag; }

ok()

bool RawFile::ok

(

)

It is OK (i.e. file was correctly opened)

Definition at line 70 of file RawFile.cc.

References inputFile.

Referenced by fail().

{ return (inputFile != nullptr); }

open()

RawFile * RawFile::open

(

const char *

path

)

Open file.

Definition at line 19 of file RawFile.cc.

References gather_cfg::cout, corrVsCorr::filename, inputFile, castor_dqm_sourceclient_file_cfg::path, hcallasereventfilter2012_cfi::prefix, and xrootdFlag.

Referenced by DTDDUFileReader::DTDDUFileReader(), DTNewROS8FileReader::DTNewROS8FileReader(), DTROS25FileReader::DTROS25FileReader(), DTROS8FileReader::DTROS8FileReader(), and RawFile().

                                       {
  //cout << " Full path: " << path << endl;

  std::unique_ptr<char[]> chaux{new char[strlen(path) + 1]};
  strcpy(chaux.get(), path);
  char* saveptr;
  char* prefix = strtok_r(chaux.get(), ":", &saveptr);
  //cout << " Prefix: " << prefix << endl;

  char* filename = prefix;
  if (strlen(prefix) < strlen(path))
    filename = strtok_r(nullptr, ":", &saveptr);
  //cout << " Filename: " << filename << endl;

  if (strcmp(prefix, "root") == 0)
    xrootdFlag = true;

  if (xrootdFlag) {
    char chopt[] = "rb";
    inputFile = XrdPosix_Fopen(path, chopt);
  } else {
    char chopt[] = "rb";
    inputFile = fopen(filename, chopt);
  }
  if (!inputFile) {
    cout << "RawFile: the input file '" << path << "' is not present" << endl;
  } else {
    cout << "RawFile: DAQ file '" << path << "' was succesfully opened" << endl;
  }

  return this;
}

read()

int RawFile::read	(	void *	data,
		size_t	nbytes
	)

Read from file.

Definition at line 76 of file RawFile.cc.

References data, inputFile, and xrootdFlag.

Referenced by DTDDUFileReader::dmaUnpack(), DTDDUFileReader::DTDDUFileReader(), DTNewROS8FileReader::fillRawData(), DTROS8FileReader::fillRawData(), DTDDUFileReader::fillRawData(), DTROS25FileReader::fillRawData(), and edmIntegrityCheck.PublishToFileSystem::get().

                                           {
  if (xrootdFlag) {
    return XrdPosix_Fread(data, nbytes, 1, inputFile);
  } else {
    return fread(data, nbytes, 1, inputFile);
  }
}

seek()

int RawFile::seek	(	long	offset,
		int	whence
	)

Go somewhere.

Definition at line 84 of file RawFile.cc.

References inputFile, hltrates_dqm_sourceclient-live_cfg::offset, and xrootdFlag.

Referenced by ignore().

                                         {
  if (xrootdFlag) {
    return XrdPosix_Fseek(inputFile, offset, whence);
  } else {
    return fseek(inputFile, offset, whence);
  }
}

tell()

long RawFile::tell

(

)

Tell instruction.

Definition at line 98 of file RawFile.cc.

References inputFile, and xrootdFlag.

                   {
  if (xrootdFlag) {
    return XrdPosix_Ftell(inputFile);
  } else {
    return ftell(inputFile);
  }
}

Member Data Documentation

inputFile

FILE* RawFile::inputFile

private

Definition at line 62 of file RawFile.h.

Referenced by close(), eof(), GetPointer(), ok(), open(), read(), seek(), and tell().

xrootdFlag

bool RawFile::xrootdFlag

private

Definition at line 63 of file RawFile.h.

Referenced by close(), isXROOTD(), open(), read(), seek(), and tell().