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::RawFile

(

)

Default constructor.

Definition at line 15 of file RawFile.cc.

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

RawFile::RawFile

(

const char *

path

)

Usual constructor.

Definition at line 17 of file RawFile.cc.

References open().

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

RawFile::~RawFile ( )

virtual

Destructor.

Definition at line 67 of file RawFile.cc.

References close().

{close();}

Member Function Documentation

int RawFile::close

(

void

)

Close file if necessary.

Definition at line 54 of file RawFile.cc.

References RemoveAddSevLevel::flag, inputFile, and xrootdFlag.

Referenced by lumiQTWidget.ApplicationWindow::fileQuit(), esMonitoring.AsyncLineReaderMixin::handle_close(), esMonitoring.FDJsonServer::handle_close(), Vispa.Gui.BoxContentDialog.BoxContentDialog::keyPressEvent(), Vispa.Gui.FindDialog.FindDialog::keyPressEvent(), 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;
}

int RawFile::eof

(

)

Check end of file.

Definition at line 95 of file RawFile.cc.

References inputFile.

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

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

bool RawFile::fail

(

)

It is not OK.

Definition at line 73 of file RawFile.cc.

References ok().

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

{ return !ok();}

FILE * RawFile::GetPointer

(

)

Get file pointer.

Definition at line 69 of file RawFile.cc.

References inputFile.

{ return inputFile;}

int RawFile::ignore

(

long

offset

)

Ignore some bytes.

Definition at line 93 of file RawFile.cc.

References seek().

Referenced by DTDDUFileReader::DTDDUFileReader().

{ return seek(offset, SEEK_CUR);}

bool RawFile::isRFIO

(

)

Castor flag.

bool RawFile::isXROOTD

(

)

XROOTD flag.

Definition at line 75 of file RawFile.cc.

References xrootdFlag.

{ return xrootdFlag;}

bool RawFile::ok

(

)

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

Definition at line 71 of file RawFile.cc.

References inputFile.

Referenced by fail().

{ return (inputFile!=nullptr);}

RawFile * RawFile::open

(

const char *

path

)

Open file.

Definition at line 21 of file RawFile.cc.

References gather_cfg::cout, corrVsCorr::filename, inputFile, callgraph::path, tablePrinter::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;

}

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

Read from file.

Definition at line 77 of file RawFile.cc.

References 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);
  }
}

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

Go somewhere.

Definition at line 85 of file RawFile.cc.

References inputFile, and xrootdFlag.

Referenced by ignore().

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

long RawFile::tell

(

)

Tell instruction.

Definition at line 99 of file RawFile.cc.

References inputFile, and xrootdFlag.

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

Member Data Documentation

FILE* RawFile::inputFile

private

Definition at line 63 of file RawFile.h.

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

bool RawFile::xrootdFlag

private

Definition at line 64 of file RawFile.h.

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