In This Package:

DayaBay::RawModule Class Reference

#include <RawData.h>

Inheritance diagram for DayaBay::RawModule:

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

Public Member Functions
	RawModule (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
	~RawModule ()
unsigned int	size () const
unsigned int	headerSize () const
unsigned int	siteId () const
unsigned int	detectorId () const
unsigned int	moduleType () const
unsigned int	slot () const
bool	isLocalTriggerModule () const
bool	isPmtFeeModule () const
bool	isFlashAdcModule () const
bool	isRpcRomModule () const
bool	isRpcRtmModule () const
DayaBay::HeadFragment *	headFragment ()
DayaBay::DataFragment *	nextDataFragment ()
void	resetDataFragment ()
virtual std::ostream &	dump (std::ostream &str)
DayaBay::RawFragment *	makeNewFragment (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
DayaBay::HeadFragment *	makeNewHeadFragment (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
DayaBay::TailFragment *	makeNewTailFragment (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
DayaBay::DataFragment *	makeNewDataFragment (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
unsigned int	type () const
unsigned int	majorVersion () const
unsigned int	minorVersion () const
bool	isEventType () const
bool	isModuleType () 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 DayaBay::RawData *	makeNewData (unsigned int *buffer=0, unsigned int majorVersion=0, unsigned int minorVersion=0, bool isOwner=false)
Protected Attributes
unsigned int	m_majorVersion
unsigned int	m_minorVersion
Private Attributes
unsigned int	m_currentFragmentLine

---

Detailed Description

Definition at line 218 of file RawData.h.

---

Constructor & Destructor Documentation

DayaBay::RawModule::RawModule	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)

Definition at line 316 of file RawData.cc.

  : RawData(buffer,majorVersion,minorVersion,isOwner),
    m_currentFragmentLine(0)
{
  // Default constructor
}

DayaBay::RawModule::~RawModule

(

)

Definition at line 326 of file RawData.cc.

{
  // Destructor
  m_currentFragmentLine=0;
}

---

Member Function Documentation

unsigned int DayaBay::RawModule::size

(

)

const

Definition at line 332 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::totalSizeLine,
                        DataFormat::Module::totalSizeBitOffset,
                        DataFormat::Module::totalSizeBitLength);
}

unsigned int DayaBay::RawModule::headerSize

(

)

const

Definition at line 339 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::headerSizeLine,
                        DataFormat::Module::headerSizeBitOffset,
                        DataFormat::Module::headerSizeBitLength);
}

unsigned int DayaBay::RawModule::siteId

(

)

const

Definition at line 347 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::siteIdLine,
                        DataFormat::Module::siteIdBitOffset,
                        DataFormat::Module::siteIdBitLength);
}

unsigned int DayaBay::RawModule::detectorId

(

)

const

Definition at line 354 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::detectorIdLine,
                        DataFormat::Module::detectorIdBitOffset,
                        DataFormat::Module::detectorIdBitLength);
}

unsigned int DayaBay::RawModule::moduleType

(

)

const

Definition at line 361 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::moduleTypeLine,
                        DataFormat::Module::moduleTypeBitOffset,
                        DataFormat::Module::moduleTypeBitLength);
}

unsigned int DayaBay::RawModule::slot

(

)

const

Definition at line 368 of file RawData.cc.

{
  return this->getValue(DataFormat::Module::slotLine,
                        DataFormat::Module::slotBitOffset,
                        DataFormat::Module::slotBitLength);
}

bool DayaBay::RawModule::isLocalTriggerModule

(

)

const

Definition at line 375 of file RawData.cc.

{
  // Is this a Local Trigger Board Module block?
  return (this->moduleType()==DataFormat::Module::LocalTrigger);
}

bool DayaBay::RawModule::isPmtFeeModule

(

)

const

Definition at line 381 of file RawData.cc.

{
  // Is this a PMT FEE Board Module block?
  return (this->moduleType()==DataFormat::Module::PmtFee);
}

bool DayaBay::RawModule::isFlashAdcModule

(

)

const

Definition at line 387 of file RawData.cc.

{
  // Is this a Flash ADC Module block?
  return (this->moduleType()==DataFormat::Module::FlashAdc);
}

bool DayaBay::RawModule::isRpcRomModule

(

)

const

Definition at line 393 of file RawData.cc.

{
  // Is this an RPC ROM Module block?
  return (this->moduleType()==DataFormat::Module::RpcRom);
}

bool DayaBay::RawModule::isRpcRtmModule

(

)

const

Definition at line 399 of file RawData.cc.

{
  // Is this an RPC RTM Module block?
  return (this->moduleType()==DataFormat::Module::RpcRtm);
}

DayaBay::HeadFragment * DayaBay::RawModule::headFragment

(

)

Definition at line 405 of file RawData.cc.

{
  unsigned int headFragmentLine = DataFormat::Module::firstFragmentLine;
  // Check for CBLT header line
  if( DayaBay::RawFragment(this->getPointer(headFragmentLine),
                           this->majorVersion(),
                           this->minorVersion()).type()
      == DataFormat::CbltHeadFragment::type){
    // Skip CBLT header line
    headFragmentLine += DataFormat::CbltHeadFragment::size;
  }
  DayaBay::RawFragment* rawFragment = 
    this->makeNewFragment(
             this->getPointer(headFragmentLine),
             this->majorVersion(),
             this->minorVersion());
  DayaBay::HeadFragment* headFragment = 
    dynamic_cast<DayaBay::HeadFragment*>(rawFragment);
  if(!headFragment){
    delete rawFragment;
    return 0;
  }
  return headFragment;
}

DayaBay::DataFragment * DayaBay::RawModule::nextDataFragment

(

)

Definition at line 430 of file RawData.cc.

{
  unsigned int nextFragmentLine = m_currentFragmentLine;
  if(!m_currentFragmentLine){
    // Find first data fragment
    nextFragmentLine = DataFormat::Module::firstFragmentLine;
    // Check for CBLT header line
    if( DayaBay::RawFragment(this->getPointer(nextFragmentLine),
                             this->majorVersion(),
                             this->minorVersion()).type()
        == DataFormat::CbltHeadFragment::type){
      // Skip CBLT header line
      nextFragmentLine += DataFormat::CbltHeadFragment::size;
    }
    // Check for header line
    if( DayaBay::RawFragment(this->getPointer(nextFragmentLine),
                             this->majorVersion(),
                             this->minorVersion()).type()
        == DataFormat::HeadFragment::type){
      // Skip header line
      nextFragmentLine += DataFormat::HeadFragment::size;
    }
  }else{
    DayaBay::DataFragment* fragment = 
      this->makeNewDataFragment(this->getPointer(m_currentFragmentLine),
                                this->majorVersion(),
                                this->minorVersion());
    nextFragmentLine += fragment->size();
    delete fragment;
  }
  if(nextFragmentLine >= this->size()){
    return 0;
  }
  DayaBay::DataFragment* nextFragment = 
    this->makeNewDataFragment(this->getPointer(nextFragmentLine),
                              this->majorVersion(),
                              this->minorVersion());
  if( !nextFragment ) return 0;
  m_currentFragmentLine = nextFragmentLine;
  return nextFragment;
}

void DayaBay::RawModule::resetDataFragment

(

)

Definition at line 472 of file RawData.cc.

{
  m_currentFragmentLine=0;
}

std::ostream & DayaBay::RawModule::dump

(

std::ostream &

str

)

[virtual]

Reimplemented from DayaBay::RawData.

Definition at line 477 of file RawData.cc.

                                                 {
  // Print the module information
  str << "Module {" << std::endl << "  ";
  this->RawData::dump(str);
  str << "  size: " << this->size() << std::endl
      << "  headerSize: " << this->headerSize() << std::endl
      << "  siteId: " << this->siteId() << std::endl
      << "  detectorId: " << this->detectorId() << std::endl
      << "  moduleType: " << this->moduleType() << std::endl
      << "  slot: " << this->slot() << std::endl << "  ";
  DayaBay::HeadFragment* headFragment = this->headFragment();
  if(headFragment)
    this->headFragment()->dump(str);
  unsigned int fragmentLine = m_currentFragmentLine;
  this->resetDataFragment();
  DayaBay::DataFragment* dataFragment = 0;
  while( (dataFragment=this->nextDataFragment()) ){
    str << std::endl << "  ";
    dataFragment->dump(str);
  }
  m_currentFragmentLine = fragmentLine; // Restore module line counter
  return str << "}" << std::endl;
}

DayaBay::RawFragment * DayaBay::RawModule::makeNewFragment	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)

Definition at line 501 of file RawData.cc.

{
  // Make a new raw fragment.  Automatically set the correct class
  // type using the type() defined in the raw data.
  // 
  // The caller is responsible for deleting the returned object.
  
  DayaBay::RawFragment* newFragment = 0;
  // Convert to the proper record type
  switch (DayaBay::RawFragment(buffer,majorVersion,minorVersion).type()){
  case DataFormat::HeadFragment::type:
    newFragment = this->makeNewHeadFragment(buffer, majorVersion, minorVersion, 
                                            isOwner);
    break;
  case DataFormat::DataFragment::type:
  case DataFormat::FeePeakData_v1::chargeLineType:
  case DataFormat::FeePeakData_v1::timeLineType:
    newFragment = this->makeNewDataFragment(buffer,majorVersion,minorVersion, 
                                            isOwner);
    break;
  case DataFormat::TailFragment::type:
    newFragment = this->makeNewTailFragment(buffer, majorVersion, minorVersion, 
                                            isOwner);
    break;
  default:
    newFragment = new DayaBay::RawFragment(buffer, majorVersion, minorVersion, 
                                           isOwner);
    break;
  }
  return newFragment;
}

DayaBay::HeadFragment * DayaBay::RawModule::makeNewHeadFragment	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)

Definition at line 537 of file RawData.cc.

{
  // Make a new head fragment.  Automatically set the correct class
  // type using the type() defined in the raw data.
  // 
  // The caller is responsible for deleting the returned object.
  
  DayaBay::HeadFragment* newFragment = 0;
  if( DayaBay::RawFragment(buffer,majorVersion,minorVersion).type() !=
      DataFormat::HeadFragment::type ){
    return 0;
  }
  if( this->isPmtFeeModule() ){
    // Use FEE-specific data head
    newFragment = new DayaBay::FeeHeadFragment(buffer, majorVersion, 
                                               minorVersion, isOwner);
  }else if( this->isLocalTriggerModule() ){
    // Use LTB-specific data head
    newFragment = new DayaBay::LtbHeadFragment(buffer, majorVersion,
                                               minorVersion, isOwner);
  }else{
    // Use generic data head
    newFragment = new DayaBay::HeadFragment(buffer, majorVersion, 
                                            minorVersion, isOwner);
  }
  return newFragment;
}

DayaBay::TailFragment * DayaBay::RawModule::makeNewTailFragment	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)

Definition at line 569 of file RawData.cc.

{
  // Make a new tail fragment.  Automatically set the correct class
  // type using the type() defined in the raw data.
  // 
  // The caller is responsible for deleting the returned object.
  
  DayaBay::TailFragment* newFragment = 0;
  if( DayaBay::RawFragment(buffer,majorVersion,minorVersion).type() !=
      DataFormat::TailFragment::type ){
    return 0;
  }
  if( this->isPmtFeeModule() ){
    // Use FEE-specific data tail
    newFragment = new DayaBay::FeeTailFragment(buffer, majorVersion, 
                                               minorVersion, isOwner);
  }else if( this->isLocalTriggerModule() ){
    // Use LTB-specific data tail
    newFragment = new DayaBay::LtbTailFragment(buffer, majorVersion,
                                               minorVersion, isOwner);
  }else{
    // Use generic data tail
    newFragment = new DayaBay::TailFragment(buffer, majorVersion, 
                                            minorVersion, isOwner);
  }
  return newFragment;
}

DayaBay::DataFragment * DayaBay::RawModule::makeNewDataFragment	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)

Definition at line 602 of file RawData.cc.

{
  // Make a new data fragment.  Automatically set the correct class
  // type using the type() defined in the raw data.
  // 
  // The caller is responsible for deleting the returned object.
  
  DayaBay::DataFragment* newFragment = 0;
  unsigned int fragmentType = 
    DayaBay::RawFragment(buffer,majorVersion,minorVersion).type();
  if( (fragmentType != DataFormat::DataFragment::type)
      && (fragmentType != DataFormat::FeePeakData_v1::chargeLineType)
      && (fragmentType != DataFormat::FeePeakData_v1::timeLineType) ){
    return 0;
  }
  if( this->isPmtFeeModule() ){
    // FIXME: need to discriminate different data fragment types!
    // Assume ADC/TDC Peak-finding blocks for all PMT data
    DayaBay::HeadFragment* head = this->headFragment();
    DayaBay::FeeHeadFragment* feeHead = 
      dynamic_cast<DayaBay::FeeHeadFragment*>( head );
    if(!feeHead){
      // DEBUG
      std::cout << "ERROR: Failed to find FEE Header" << std::endl;
    }else{
      newFragment = new DayaBay::FeePeakData(buffer, majorVersion, 
                                             minorVersion,
                                             feeHead->feeDataVersion(),
                                             isOwner);
    }
    delete head;
  }else if( this->isLocalTriggerModule() ){
    DayaBay::HeadFragment* head = this->headFragment();
    DayaBay::LtbHeadFragment* ltbHead = 
      dynamic_cast<DayaBay::LtbHeadFragment*>( head );
    if(!ltbHead){
      // DEBUG
      std::cout << "ERROR: Failed to find LTB Header" << std::endl;
    }else{
      newFragment = new DayaBay::LocalTriggerData(buffer, majorVersion, 
                                                  minorVersion, 
                                                  ltbHead->ltbDataVersion(),
                                                  isOwner);
    }
    delete head;
  }else{
    // Use generic data fragment
    newFragment = new DayaBay::DataFragment(buffer, majorVersion, minorVersion,
                                            isOwner);
  }
  return newFragment;
}

unsigned int DayaBay::RawData::type

(

)

const [inherited]

Reimplemented in DayaBay::RawFragment.

Definition at line 40 of file RawData.cc.

{
  // Return the type of this raw data
  return this->getValue(DataFormat::Data::typeLine);
}

unsigned int DayaBay::RawData::majorVersion

(

)

const [inherited]

Definition at line 58 of file RawData.cc.

{
  // Return the major version of this data
  return m_majorVersion;
}

unsigned int DayaBay::RawData::minorVersion

(

)

const [inherited]

Definition at line 64 of file RawData.cc.

{
  // Return the minor version of this data
  return m_minorVersion;
}

bool DayaBay::RawData::isEventType

(

)

const [inherited]

Definition at line 46 of file RawData.cc.

{
  // Is this event data?
  return (this->type()==DataFormat::Event::type);
}

bool DayaBay::RawData::isModuleType

(

)

const [inherited]

Definition at line 52 of file RawData.cc.

{
  // Is this module data?
  return (this->type()==DataFormat::Module::type);
}

DayaBay::RawData * DayaBay::RawData::makeNewData	(	unsigned int *	buffer = 0,
		unsigned int	majorVersion = 0,
		unsigned int	minorVersion = 0,
		bool	isOwner = false
	)			[static, inherited]

Definition at line 101 of file RawData.cc.

                                                                       {
  // Make a new raw data object.  Automatically set the correct class
  // type using the type() defined in the raw data.
  // 
  // The caller is responsible for deleting the returned data object.
  
  DayaBay::RawData* newData = 0;
  // Convert to the proper record type
  DayaBay::RawData rawData(buffer,majorVersion,minorVersion);
  if( rawData.isEventType() ){
    newData = new DayaBay::RawEvent(buffer, majorVersion, minorVersion, 
                                    isOwner);
  }else if( rawData.isModuleType() ){
    newData = new DayaBay::RawModule(buffer, majorVersion, minorVersion, 
                                     isOwner);
  }else{
    newData = new DayaBay::RawData(buffer, majorVersion, minorVersion,
                                   isOwner);
  }
  return newData;
}

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

---

Member Data Documentation

unsigned int DayaBay::RawModule::m_currentFragmentLine [private]

Definition at line 259 of file RawData.h.

unsigned int DayaBay::RawData::m_majorVersion [protected, inherited]

Definition at line 32 of file RawData.h.

unsigned int DayaBay::RawData::m_minorVersion [protected, inherited]

Definition at line 33 of file RawData.h.

---

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/RawData.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DataModel/RawData/src/RawData.cc

---