In This Package:

DayaBay::RawFileName Class Reference

#include <RawRecord.h>

Inheritance diagram for DayaBay::RawFileName:

[legend]Collaboration diagram for DayaBay::RawFileName:[legend]List of all members.

Public Member Functions
	RawFileName (unsigned int *buffer=0, unsigned int version=0, bool isOwner=false)
	RawFileName (DayaBay::RawRecord &record, bool adopt=false)
virtual	~RawFileName ()
char *	appName () const
unsigned int	appNameLength () const
char *	fileName () const
unsigned int	fileNameLength () const
virtual std::ostream &	dump (std::ostream &str)
unsigned int	type () const
unsigned int	size () const
unsigned int	version () const
bool	isFileStart () const
bool	isFileName () const
bool	isMetadata () const
bool	isRunParameters () const
bool	isCalibrationParameters () const
bool	isDataSeparator () const
bool	isFileEnd () const
DayaBay::RawRecord *	clone () const
unsigned int *	buffer () const
unsigned int	bufferSize () const
bool	isOwner () const
void	setOwner (bool isOwner=true)
virtual bool	isValid () const
unsigned int *	getPointer (const unsigned int &line) const
unsigned int	getValue (const unsigned int &line, const unsigned int &firstBit=0, const unsigned int &bitLength=32) const
char *	getString (const unsigned int &line, const unsigned int &byteOffset=0) const
Static Public Member Functions
static unsigned int	minimumSize ()
static DayaBay::RawRecord *	makeNewRecord (unsigned int *buffer=0, unsigned int version=0, bool isOwner=false)

---

Detailed Description

Definition at line 63 of file RawRecord.h.

---

Constructor & Destructor Documentation

DayaBay::RawFileName::RawFileName	(	unsigned int *	buffer = 0,
		unsigned int	version = 0,
		bool	isOwner = false
	)

Definition at line 231 of file RawRecord.cc.

  : RawRecord(buffer,version,isOwner)
{
  // Default constructor
}

DayaBay::RawFileName::RawFileName	(	DayaBay::RawRecord &	record,
		bool	adopt = false
	)

Definition at line 239 of file RawRecord.cc.

  : RawRecord(record,adopt)
{
  // Construct from another RawRecord
  // If adopt==true, then take over ownership of the 
  // memory buffer (if the input record is the current owner)
}

DayaBay::RawFileName::~RawFileName

(

)

[virtual]

Definition at line 248 of file RawRecord.cc.

{
  // Destructor
}

---

Member Function Documentation

char * DayaBay::RawFileName::appName

(

)

const

Definition at line 253 of file RawRecord.cc.

{
  return this->getString(RecordFormat::FileName::appNameLine);
}

unsigned int DayaBay::RawFileName::appNameLength

(

)

const

Definition at line 258 of file RawRecord.cc.

{
  return this->getValue(RecordFormat::FileName::appNameLengthLine);
}

char * DayaBay::RawFileName::fileName

(

)

const

Definition at line 263 of file RawRecord.cc.

{
  // Add enough integer lines to account for app name string size
  unsigned int stringLineLength = this->appNameLength()*sizeof(char)
    +sizeof(unsigned int) - 1;
  stringLineLength /= sizeof(unsigned int);
  return this->getString(RecordFormat::FileName::appNameLine
                         +stringLineLength+1);
}

unsigned int DayaBay::RawFileName::fileNameLength

(

)

const

Definition at line 273 of file RawRecord.cc.

{
  // Add enough integer lines to account for app name string size
  unsigned int stringLineLength = this->appNameLength()*sizeof(char)
    +sizeof(unsigned int) - 1;
  stringLineLength /= sizeof(unsigned int);
  return this->getValue(RecordFormat::FileName::appNameLine
                        +stringLineLength);
}

std::ostream & DayaBay::RawFileName::dump

(

std::ostream &

str

)

[virtual]

Reimplemented from DayaBay::RawRecord.

Definition at line 283 of file RawRecord.cc.

                                                   {
  // Print the record information
  str << "RawFileName {" << std::endl << "  ";
  this->RawRecord::dump(str);
  return str << "  appNameLength: " << this->appNameLength() << std::endl
             << "  appName: " << std::string(this->appName(),
                                             this->appNameLength()) << std::endl
             << "  fileNameLength: " << this->fileNameLength() << std::endl
             << "  fileName: " << std::string(this->fileName(),
                                              this->fileNameLength()) << " }" 
             << std::endl;
}

unsigned int DayaBay::RawRecord::type

(

)

const [inherited]

Definition at line 40 of file RawRecord.cc.

{
  // Return the type of this RawRecord
  return this->getValue(RecordFormat::Record::typeLine);
}

unsigned int DayaBay::RawRecord::size

(

)

const [inherited]

Definition at line 46 of file RawRecord.cc.

{
  // Return the size of this record, in integer segments
  return this->getValue(RecordFormat::Record::sizeLine);
}

unsigned int DayaBay::RawRecord::version

(

)

const [inherited]

Definition at line 52 of file RawRecord.cc.

{
  // Version of this record
  return m_version;
}

unsigned int DayaBay::RawRecord::minimumSize

(

)

[static, inherited]

Definition at line 34 of file RawRecord.cc.

{
  // Minimum size for all raw records.
  return RecordFormat::Record::minimumSize;
}

bool DayaBay::RawRecord::isFileStart

(

)

const [inherited]

Definition at line 58 of file RawRecord.cc.

{
  // Is this a file start record?
  return (this->type()==RecordFormat::FileStart::type);
}

bool DayaBay::RawRecord::isFileName

(

)

const [inherited]

Definition at line 64 of file RawRecord.cc.

{
  // Is this a file name record?
  return (this->type()==RecordFormat::FileName::type);
}

bool DayaBay::RawRecord::isMetadata

(

)

const [inherited]

Definition at line 70 of file RawRecord.cc.

{
  // Is this a metadata record?
  return (this->type()==RecordFormat::Metadata::type);
}

bool DayaBay::RawRecord::isRunParameters

(

)

const [inherited]

Definition at line 76 of file RawRecord.cc.

{
  // Is this a run parameters record?
  return (this->type()==RecordFormat::RunParameters::type);
}

bool DayaBay::RawRecord::isCalibrationParameters

(

)

const [inherited]

Definition at line 82 of file RawRecord.cc.

{
  // Is this a calibration parameters record?
  return (this->type()==RecordFormat::CalibrationParameters::type);
}

bool DayaBay::RawRecord::isDataSeparator

(

)

const [inherited]

Definition at line 88 of file RawRecord.cc.

{
  // Is this a data separator record?
  return (this->type()==RecordFormat::DataSeparator::type);
}

bool DayaBay::RawRecord::isFileEnd

(

)

const [inherited]

Definition at line 94 of file RawRecord.cc.

{
  // Is this a file end record?
  return (this->type()==RecordFormat::FileEnd::type);
}

DayaBay::RawRecord * DayaBay::RawRecord::clone

(

)

const [inherited]

Definition at line 100 of file RawRecord.cc.

{
  // Make a full copy of this record
  unsigned int* newBuffer = 0;
  if(this->buffer()){
    unsigned int size = this->size();
    if( this->isDataSeparator() ){ 
      // Add additional lines for data block contents
      DayaBay::RawDataSeparator dataSeparator(this->buffer(), this->version());
      size += (dataSeparator.blockSize() + sizeof(unsigned int)-1)
              / sizeof(unsigned int);
    }
    if( size>0 ){
      memcpy( newBuffer, this->buffer(), size*sizeof(unsigned int) );
      if(!newBuffer) return 0;
    }
  }
  return DayaBay::RawRecord::makeNewRecord(newBuffer, m_version, 
                                           true /*isOwner*/);
}

DayaBay::RawRecord * DayaBay::RawRecord::makeNewRecord	(	unsigned int *	buffer = 0,
		unsigned int	version = 0,
		bool	isOwner = false
	)			[static, inherited]

Definition at line 129 of file RawRecord.cc.

                                                                            {
  // Make a new record.  Automatically set the correct class type
  // using the type() defined in the raw record.
  // 
  // The caller is responsible for deleting the returned record.
  
  DayaBay::RawRecord* newRecord = 0;
  // Convert to the proper record type
  DayaBay::RawRecord rawRecord(buffer,version);
  if( rawRecord.isFileStart() ){
    newRecord = new DayaBay::RawFileStart(buffer, version, isOwner);
  }else if( rawRecord.isFileName() ){
    newRecord = new DayaBay::RawFileName(buffer, version, isOwner);
  }else if( rawRecord.isMetadata() ){
    newRecord = new DayaBay::RawMetadata(buffer, version, isOwner);
  }else if( rawRecord.isRunParameters() ){
    newRecord = new DayaBay::RawRunParameters(buffer, version, isOwner);
  }else if( rawRecord.isCalibrationParameters() ){
    newRecord = new DayaBay::RawCalibrationParameters(buffer, version, isOwner);
  }else if( rawRecord.isDataSeparator() ){
    newRecord = new DayaBay::RawDataSeparator(buffer, version, isOwner);
  }else if( rawRecord.isFileEnd() ){
    newRecord = new DayaBay::RawFileEnd(buffer, version, isOwner);
  }else{
    newRecord = new DayaBay::RawRecord(buffer, version, isOwner);
  }
  return newRecord;
}

unsigned int * DayaBay::RawBuffer::buffer

(

)

const [inherited]

Definition at line 52 of file RawBuffer.cc.

{
  // Return the pointer to the internal memory buffer
  return m_buffer;
}

unsigned int DayaBay::RawBuffer::bufferSize

(

)

const [inherited]

Definition at line 58 of file RawBuffer.cc.

{
  // Return the allocated size of the internal memory buffer, if known
  return m_bufferSize;
}

bool DayaBay::RawBuffer::isOwner

(

)

const [inherited]

Definition at line 64 of file RawBuffer.cc.

{
  // Does this RawBuffer own this memory buffer?
  return m_isOwner;
}

void DayaBay::RawBuffer::setOwner

(

bool

isOwner = true

)

[inherited]

Definition at line 70 of file RawBuffer.cc.

                                                    {
  m_isOwner = isOwner;
}

bool DayaBay::RawBuffer::isValid

(

)

const [virtual, inherited]

Definition at line 74 of file RawBuffer.cc.

{
  // Does this RawBuffer contain data?
  return (m_buffer != 0);
}

unsigned int * DayaBay::RawBuffer::getPointer

(

const unsigned int &

line

)

const [inherited]

Definition at line 80 of file RawBuffer.cc.

{
  // Return a pointer to a specific line in the data block
  if(m_bufferSize>0 && line>=m_bufferSize) return 0;
  return (m_buffer + line);
}

unsigned int DayaBay::RawBuffer::getValue	(	const unsigned int &	line,
		const unsigned int &	firstBit = 0,
		const unsigned int &	bitLength = 32
	)			const [inherited]

Definition at line 87 of file RawBuffer.cc.

{
  // Read a value from the memory buffer
  // line = line number in the memory block (line = integer length)
  // firstBit = first bit to read (max=31)
  // bitLength =  length of bits to read (max=32)
  if(bitLength>32 || firstBit>31) return 0;
  unsigned int* pointer = this->getPointer(line);
  if(!pointer) return 0;
  // Catch request for full line
  if(firstBit==0 && bitLength==32) return *pointer;
  // Prepare bit mask
  unsigned int oneBit = 0x1;
  unsigned int mask = 0;
  for(unsigned int shift=0; shift<bitLength; shift++) 
    mask += (oneBit << shift);
  // Shift value, mask, and return
  return (*pointer >> firstBit) & mask;
}

char * DayaBay::RawBuffer::getString	(	const unsigned int &	line,
		const unsigned int &	byteOffset = 0
	)			const [inherited]

Definition at line 109 of file RawBuffer.cc.

{
  // Return a char pointer to a specific byte in the data block
  // line = line number in the memory block (line = integer length)
  // byteOffset = offset if string starts at an uneven byte position (max=3)
  if(byteOffset>3) return 0;
  unsigned int* pointer = this->getPointer(line);
  if(!pointer) return 0;
  return (char*)(pointer + byteOffset);
}

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DataModel/RawData/RawData/RawRecord.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DataModel/RawData/src/RawRecord.cc

---