FileEndRecord Class Reference

#include <RawFileUtil.h>

Public Member Functions
	FileEndRecord ()
const file_end_record &	getRecord () const
void	dump (std::ostream &os=std::cout) const
void	setEventsInFile (uint32_t file_nevt)
void	setDataInFile (uint32_t file_size)
void	setEventsInRun (uint32_t run_nevt)
void	setDataInRun (uint32_t run_size)
void	setStatus (uint32_t status)

Friends
raw_ifstream &	operator>> (raw_ifstream &is, FileEndRecord &record)
raw_ifstream &	makeEndRecord (DataSeparatorRecord &sep, raw_ifstream &is, FileEndRecord &record)
raw_ofstream &	operator<< (raw_ofstream &os, FileEndRecord &record)

Detailed Description

Definition at line 158 of file RawFileUtil.h.

Constructor & Destructor Documentation

FileEndRecord()

FileEndRecord::FileEndRecord

(

)

Definition at line 276 of file RawFileUtil.cxx.

{
   m_record.marker          = 0x1234dddd;
   m_record.record_size     = 10;
   // following members are not meaningful @ offline
   m_record.date            = 0;
   m_record.time            = 0;
   //m_record.events_in_file;     //set manually
   m_record.data_in_file    = 0;
   m_record.events_in_run   = 0;
   m_record.data_in_run     = 0;
   m_record.status          = 1;
   m_record.end_marker      = 0x1234eeee;
}

Member Function Documentation

dump()

void FileEndRecord::dump

(

std::ostream &

os = std::cout

)

const

Definition at line 337 of file RawFileUtil.cxx.

                                             {
  os << "[RawFile] FileEndRecord:" << std::endl << std::hex
     << "[RawFile] \tmarker               : 0x" << m_record.marker << std::endl
     << "[RawFile] \trecord_size          : 0x" << m_record.record_size << std::endl
     << "[RawFile] \tdate                 : 0x" << m_record.date << std::endl
     << "[RawFile] \ttime                 : 0x" << m_record.time << std::endl
     << "[RawFile] \tevents_in_file       : 0x" << m_record.events_in_file << std::endl
     << "[RawFile] \tdata_in_file         : 0x" << m_record.data_in_file << std::endl
     << "[RawFile] \tevents_in_run        : 0x" << m_record.events_in_run << std::endl
     << "[RawFile] \tdata_in_run          : 0x" << m_record.data_in_run << std::endl
     << "[RawFile] \tstatus               : 0x" << m_record.status << std::endl
     << "[RawFile] \tend_marker           : 0x" << m_record.end_marker
     << std::dec << std::endl;
}

getRecord()

const file_end_record & FileEndRecord::getRecord ( ) const

inline

Definition at line 166 of file RawFileUtil.h.

{ return m_record; }

setDataInFile()

void FileEndRecord::setDataInFile ( uint32_t  file_size )

inline

Definition at line 170 of file RawFileUtil.h.

{ m_record.data_in_file = file_size; }

setDataInRun()

void FileEndRecord::setDataInRun ( uint32_t  run_size )

inline

Definition at line 172 of file RawFileUtil.h.

{ m_record.data_in_run = run_size; }

setEventsInFile()

void FileEndRecord::setEventsInFile ( uint32_t  file_nevt )

inline

Definition at line 169 of file RawFileUtil.h.

{ m_record.events_in_file = file_nevt; }

Referenced by raw_ofstream::close().

setEventsInRun()

void FileEndRecord::setEventsInRun ( uint32_t  run_nevt )

inline

Definition at line 171 of file RawFileUtil.h.

{ m_record.events_in_run = run_nevt; }

setStatus()

void FileEndRecord::setStatus ( uint32_t  status )

inline

Definition at line 173 of file RawFileUtil.h.

{ m_record.status = status; }

Friends And Related Function Documentation

makeEndRecord

raw_ifstream & makeEndRecord ( DataSeparatorRecord &  sep, raw_ifstream &  is, FileEndRecord &  record  )

friend

Definition at line 146 of file RawFileUtil.cxx.

                                                                                               {
  // copy file_end_record data that already read by data_separator_record
  memcpy((void*)&record.m_record, (const void*)&(sep.getRecord()), sizeof(data_separator_record));
  // read data block
  if (is.read((char*)(&record.m_record.events_in_file), (
      sizeof(file_end_record) - sizeof(data_separator_record)
      )).fail()) {
    //std::cerr << "[RawFile] Error occurred while reading files" << std::endl;
    throw BadInputStream("FileEndRecord");
  }
 
  // data validation checks
  if (record.m_record.marker != 0x1234dddd) {
    //std::cerr << "[RawFile] Get an invalid record marker" << std::endl;
    throw WrongMarker(0x1234dddd, record.m_record.marker);
  }
  if (record.m_record.end_marker != 0x1234eeee) {
    //std::cerr << "[RawFile] Get an invalid record marker" << std::endl;
    throw WrongMarker(0x1234eeee, record.m_record.end_marker);
  }
 
  if (record.m_record.record_size != 10) {
    //std::cerr << "[RawFile] Get an unexpected record size" << std::endl;
    throw UnexpectedRecordSize("FileEndRecord", 10, record.m_record.record_size);
  }
 
  return is;
}

operator<<

raw_ofstream & operator<< ( raw_ofstream &  os, FileEndRecord &  record  )

friend

Definition at line 222 of file RawFileUtil.cxx.

                                                                  {
  // write data block
  if (os.write((char*)(&record.m_record), sizeof(file_end_record)).fail()) {
    std::cerr << "[RawFile] Error occurred while writing file" << std::endl;
    throw FailedToWrite("FileEndRecord");
  }
 
  return os;
}

operator>>

raw_ifstream & operator>> ( raw_ifstream &  is, FileEndRecord &  record  )

friend

Definition at line 121 of file RawFileUtil.cxx.

                                                                  {
  // read data block
  if (is.read((char*)(&record.m_record), sizeof(file_end_record)).fail()) {
    //std::cerr << "[RawFile] Error occurred while reading files" << std::endl;
    throw BadInputStream("FileEndRecord");
  }
 
  // data validation checks
  if (record.m_record.marker != 0x1234dddd) {
    //std::cerr << "[RawFile] Get an invalid record marker" << std::endl;
    throw WrongMarker(0x1234dddd, record.m_record.marker);
  }
  if (record.m_record.end_marker != 0x1234eeee) {
    //std::cerr << "[RawFile] Get an invalid record marker" << std::endl;
    throw WrongMarker(0x1234eeee, record.m_record.end_marker);
  }
 
  if (record.m_record.record_size != 10) {
    //std::cerr << "[RawFile] Get an unexpected record size" << std::endl;
    throw UnexpectedRecordSize("FileEndRecord", 10, record.m_record.record_size);
  }
 
  return is;
}

---

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

• RawFileUtil.h
• RawFileUtil.cxx