In This Package:

DayaBay::RawBuffer Class Reference

#include <RawBuffer.h>

Inheritance diagram for DayaBay::RawBuffer:

[legend]List of all members.

Public Member Functions
	RawBuffer ()
	RawBuffer (unsigned int *buffer, bool isOwner=false, unsigned int bufferSize=0)
	RawBuffer (DayaBay::RawBuffer &buffer, bool adopt=false)
virtual	~RawBuffer ()
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
Private Attributes
unsigned int *	m_buffer
unsigned int	m_bufferSize
bool	m_isOwner

---

Detailed Description

Definition at line 12 of file RawBuffer.h.

---

Constructor & Destructor Documentation

DayaBay::RawBuffer::RawBuffer

(

)

Definition at line 5 of file RawBuffer.cc.

  : m_buffer(0),
    m_bufferSize(0),
    m_isOwner(false)
{
  // Default constructor
}

DayaBay::RawBuffer::RawBuffer	(	unsigned int *	buffer,
		bool	isOwner = false,
		unsigned int	bufferSize = 0
	)

Definition at line 13 of file RawBuffer.cc.

  : m_buffer(buffer),
    m_bufferSize(bufferSize),
    m_isOwner(isOwner)
{
  // Standard constructor
}

DayaBay::RawBuffer::RawBuffer	(	DayaBay::RawBuffer &	buffer,
		bool	adopt = false
	)

Definition at line 23 of file RawBuffer.cc.

  : m_buffer(0),
    m_bufferSize(0),
    m_isOwner(false)
{
  // Construct from another RawBuffer
  // If adopt==true, then take over ownership of the 
  // memory buffer (if the input buffer is the current owner)
  m_buffer = buffer.buffer();
  m_isOwner = false;
  m_bufferSize = buffer.bufferSize();
  if(adopt && buffer.isOwner()){
    // Make new RawBuffer the owner of this memory
    m_isOwner = true;
    buffer.setOwner(false);
  }
}

DayaBay::RawBuffer::~RawBuffer

(

)

[virtual]

Definition at line 43 of file RawBuffer.cc.

{
  // Destructor
  if(m_isOwner && m_buffer) free(m_buffer);
  m_buffer=0;
  m_bufferSize=0;
  m_isOwner=false;
}

---

Member Function Documentation

unsigned int * DayaBay::RawBuffer::buffer

(

)

const

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

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

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

)

Definition at line 70 of file RawBuffer.cc.

                                                    {
  m_isOwner = isOwner;
}

bool DayaBay::RawBuffer::isValid

(

)

const [virtual]

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

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

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

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::RawBuffer::m_buffer [private]

Definition at line 32 of file RawBuffer.h.

unsigned int DayaBay::RawBuffer::m_bufferSize [private]

Definition at line 33 of file RawBuffer.h.

bool DayaBay::RawBuffer::m_isOwner [private]

Definition at line 34 of file RawBuffer.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/RawBuffer.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DataModel/RawData/src/RawBuffer.cc

---