TileCalibDrawerDat< T > Class Template Reference

Generic template class for storing a number of "T"s for each channel or ADC. More...

#include <TileCalibDrawerDat.h>

Inheritance diagram for TileCalibDrawerDat< T >:

Collaboration diagram for TileCalibDrawerDat< T >:

Public Types
typedef std::vector< std::vector< T > >	DefType
	Object to hold default data used for initialization.

Public Member Functions
virtual	~TileCalibDrawerDat ()
	Dtor.
T	getData (unsigned int channel, unsigned int adc, unsigned int idx) const
	Returns a single T belonging to a channel/ADC.
void	init (const DefType &def, uint16_t nChans, uint16_t objVers, const std::string &author="", const std::string &comment="", uint64_t timeStamp=0)
	Initializing function.
void	setData (unsigned int channel, unsigned int adc, unsigned int idx, T data)
	Sets a single T belonging to a channel/ADC.
void	setData (unsigned int channel, unsigned int adc, const std::vector< T > &data)
	Sets a number of Ts stored in the input vector.
virtual void	dump () const
	Prints out the content of the blob to std::out.
virtual void	dump (std::ostream &stm) const
	Prints out the content of the blob.
virtual void	clone (const TileCalibDrawerBase &other)
	Initialzes Blob with content of other Blob.
virtual uint16_t	getType () const
	Returns TileCalibDrawer::BASE.
long	getBlobSize () const
	Returns the BLOB size in units of bytes.
long	getBlobSize32 () const
	Returns the BLOB size in units of uint32_t.
uint16_t	getObjType () const
	Returns the BLOB object type.
uint16_t	getObjVersion () const
	Returns the BLOB object version.
uint32_t	getObjSizeUint32 () const
	Returns the size of a data object in units of uint32_t.
uint32_t	getObjSizeByte () const
	Returns the size of a data object in units of bytes.
uint32_t	getNObjs () const
	Returns the number of data objects stored int the BLOB.
uint16_t	getNChans () const
	Returns the number of channels stored in the BLOB.
uint16_t	getNGains () const
	Returns the number of gains stored for each channel.
uint32_t	getCommentSizeUint32 () const
	Returns the space occupied by the comment fields in units of uint32_t.
uint32_t	getCommentSizeChar () const
	Returns the space occupied by the comment fields in units of chars.
std::string	getAuthor () const
	Returns the comment author.
std::string	getComment () const
	Returns the actual comment.
uint64_t	getTimeStamp () const
	Returns the unix timestamp of the comment (seconds since 1.1.1970)
std::string	getDate () const
	Returns the date of the comment as string (derived from timestamp)
std::string	getFullComment () const
	Returns a formated string build from all comment fields.
const void *	getAddress (unsigned int iEle) const
	Returns start address of iEle-th basic unit.
void *	getAddress (unsigned int iEle)

Static Public Attributes
static const unsigned int	m_hdrSize32 = 5
	The header size in units of uint32_t.

Protected Member Functions
	TileCalibDrawerDat (const coral::Blob &blob)
	Ctor (const).
	TileCalibDrawerDat (coral::Blob &blob)
	Ctor (non-const).
const T *	getAddress (unsigned int channel, unsigned int adc) const
	Returns a pointer to the first value for the specified channel & ADC.
T *	getAddress (unsigned int channel, unsigned int adc)
uint32_t	createBlob (uint16_t objType, uint16_t objVersion, uint32_t objSizeUint32, uint32_t nObjs, uint16_t nChans, uint16_t nGains, const std::string &author="", const std::string &comment="", uint64_t timeStamp=0)
	(re-)creation of the referenced BLOB object.
void	dumpHeader (std::ostream &stm) const
	Prints the BLOB header summary information.

Private Attributes
coral::Blob *	m_blob_nc
	Non-const reference to the BLOB.
const coral::Blob *	m_blob
	Const reference to the BLOB (always there)
const uint32_t *	m_blobStart32
	Cache blob starting address as uint_32t*.
const uint16_t *	m_blobStart16
	Cache blob starting address as uint_16t*.
uint64_t	m_blobSize32
	Cache blob size in units of uint32_t.
bool	m_isBlobOwner
	Is this TileCalibDrawer owner of the BLOB.

Detailed Description

template<class T>
class TileCalibDrawerDat< T >

Generic template class for storing a number of "T"s for each channel or ADC.

Author

Nils Gollub nils..nosp@m.goll.nosp@m.ub@ce.nosp@m.rn.c.nosp@m.h

This class implements the infrastructure to store a (variable) number of Ts for each channel or ADC. Only types that are a multiple of uint32_t can be stored, i.e. float, uint32_t, uint64_t, etc... The number of Ts to store is encoded in the objSize header variable. The object version header variable has no meaning for this class (since schema evolution does not make sense here) and is always set to 0.

Definition at line 30 of file TileCalibDrawerDat.h.

Member Typedef Documentation

DefType

template<class T>

typedef std::vector<std::vector<T> > TileCalibDrawerDat< T >::DefType

Object to hold default data used for initialization.

The length of the first and second vector determines respectively the number of gains and values per gain to be stored. The indexing is thus DefType[iGain][iValue].

Definition at line 37 of file TileCalibDrawerDat.h.

Constructor & Destructor Documentation

~TileCalibDrawerDat()

template<class T>

virtual TileCalibDrawerDat< T >::~TileCalibDrawerDat ( )

inlinevirtual

Dtor.

Definition at line 40 of file TileCalibDrawerDat.h.

{}

TileCalibDrawerDat() [1/2]

template<class T>

TileCalibDrawerDat< T >::TileCalibDrawerDat ( const coral::Blob & blob )

inlineprotected

Ctor (const).

Derived classes should set doTypeCheck=false and do their own check.

Definition at line 89 of file TileCalibDrawerDat.h.

: TileCalibDrawerBase(blob){}

TileCalibDrawerDat() [2/2]

template<class T>

TileCalibDrawerDat< T >::TileCalibDrawerDat ( coral::Blob & blob )

inlineprotected

Ctor (non-const).

Derived classes should set doTypeCheck=false and do their own check.

Definition at line 92 of file TileCalibDrawerDat.h.

: TileCalibDrawerBase(blob){}

Member Function Documentation

clone()

void TileCalibDrawerBase::clone ( const TileCalibDrawerBase & other )

virtualinherited

Initialzes Blob with content of other Blob.

Parameters

other

TileCalibDrawer used for initialization

Definition at line 74 of file TileCalibDrawerBase.cxx.

{
  //=== copy content of other blob
  *m_blob_nc = *other.m_blob;
  //=== and reset cached attributes
  m_blobStart32 = static_cast<const uint32_t*>(m_blob->startingAddress());
  m_blobStart16 = static_cast<const uint16_t*>(m_blob->startingAddress());
  m_blobSize32  = m_blob->size()/sizeof(uint32_t);
}

createBlob()

uint32_t TileCalibDrawerBase::createBlob ( uint16_t objType, uint16_t objVersion, uint32_t objSizeUint32, uint32_t nObjs, uint16_t nChans, uint16_t nGains, const std::string & author = "", const std::string & comment = "", uint64_t timeStamp = 0 )

protectedinherited

(re-)creation of the referenced BLOB object.

Parameters

objType	Object type
objVersion	Object version
objSizeUint32	Size of a data object (in uint32_t)
nObjs	Total number of data objects
nChans	number of stored channels
nGains	number of stored gains
author	comment author
comment	actual comment
timeStamp	unix time stamp (if 0, current time is used)

Definition at line 87 of file TileCalibDrawerBase.cxx.

{
  //=== blob data length including header in bytes
  uint32_t dataSizeByte = (m_hdrSize32+objSizeUint32*nObjs) * sizeof(uint32_t);
  
  //=== calculate comment length, including two ASCII NULLs to end text fields
  uint32_t commentSizeChar(0);
  if(author.size() || comment.size() || timeStamp){
    commentSizeChar += author.size()+comment.size()+sizeof(uint64_t) + 2;
    //=== force comment length to end on 4 byte boundary
    commentSizeChar += (commentSizeChar % sizeof(uint32_t)) ? 
      (sizeof(uint32_t)-(commentSizeChar % sizeof(uint32_t))) : 0;
  }
  
  //=== create blob
  uint32_t blobSizeInBytes = dataSizeByte+commentSizeChar;
  m_blob_nc->resize(blobSizeInBytes);
  uint32_t* blobStart32 = static_cast<uint32_t*>(m_blob_nc->startingAddress());
  uint16_t* blobStart16 = static_cast<uint16_t*>(m_blob_nc->startingAddress());
  m_blobSize32  = m_blob_nc->size()/sizeof(uint32_t);
 
  m_blobStart32 = blobStart32;
  m_blobStart16 = blobStart16;
 
  //=== fill header
  blobStart16[0] = objType;
  blobStart16[1] = objVersion;
  blobStart32[1] = objSizeUint32;
  blobStart32[2] = nObjs;
  blobStart16[6] = nChans;
  blobStart16[7] = nGains;
  blobStart32[4] = commentSizeChar/sizeof(uint32_t);
  
  //==== fill comment fields
  if(commentSizeChar){
    if(!timeStamp) timeStamp = ::time(0);
    uint64_t* pTimeStamp = reinterpret_cast<uint64_t*>(blobStart32+dataSizeByte/sizeof(uint32_t));
    pTimeStamp[0] = timeStamp;
    char* pChar = reinterpret_cast<char*>(++pTimeStamp); 
    std::string::const_iterator iStr = author.begin();
    for(; iStr!=author.end(); ++iStr){ *pChar = *iStr; ++pChar; }
    *pChar = 0; 
    for(iStr=comment.begin(); iStr!=comment.end(); ++iStr){ *(++pChar) = *iStr; }
    *(++pChar) = 0;
  }
 
  return (blobSizeInBytes/sizeof(uint32_t));
}

dump() [1/2]

template<class T>

virtual void TileCalibDrawerDat< T >::dump ( ) const

inlinevirtual

Prints out the content of the blob to std::out.

Reimplemented from TileCalibDrawerBase.

Definition at line 81 of file TileCalibDrawerDat.h.

{ dump(std::cout); }

dump() [2/2]

template<class T>

void TileCalibDrawerDat< T >::dump ( std::ostream & stm ) const

virtual

Prints out the content of the blob.

Parameters

stm	The stream to print to

Reimplemented from TileCalibDrawerBase.

Definition at line 212 of file TileCalibDrawerDat.h.

{
  TileCalibDrawerBase::dumpHeader(stm);
  for(unsigned int channel=0; channel<getNChans(); ++channel){
    for(unsigned int adc=0; adc<getNGains(); ++adc){
      stm << channel<<"/"<<adc<<":\t";
      for(unsigned int idx=0; idx<getObjSizeUint32(); ++idx){
    stm << getData(channel,adc,idx) << "\t";
      }
      stm << std::endl;
    }
  }
}

dumpHeader()

void TileCalibDrawerBase::dumpHeader ( std::ostream & stm ) const

protectedinherited

Prints the BLOB header summary information.

Parameters

stm	output stream to use

Definition at line 200 of file TileCalibDrawerBase.cxx.

{
  stm << "This is a " << TileCalibType::getClassName(getObjType()) << std::endl;
  stm << "ObjType        : " << getObjType()     << std::endl;
  stm << "ObjVersion     : " << getObjVersion()  << std::endl;
  stm << "ObjSize [bytes]: " << getObjSizeByte() << std::endl;
  stm << "NObjs          : " << getNObjs()       << std::endl;
  stm << "NChannels      : " << getNChans()      << std::endl;
  stm << "NGains         : " << getNGains()      << std::endl;
  if(!getCommentSizeUint32()){
    stm << "=== No comment available ===" << std::endl;
  }
  else{
    stm << "Author         : " << getAuthor()      << std::endl;
    stm << "Date           : " << getDate() << " ("<< getTimeStamp() << ")" << std::endl;
    stm << "Comment:       : " << getComment()     << std::endl;
  }  
}

getAddress() [1/4]

void * TileCalibDrawerBase::getAddress ( unsigned int iEle )

inherited

getAddress() [2/4]

const void * TileCalibDrawerBase::getAddress ( unsigned int iEle ) const

inherited

Returns start address of iEle-th basic unit.

Parameters

iEle	sequential basic unit number

getAddress() [3/4]

template<class T>

T * TileCalibDrawerDat< T >::getAddress ( unsigned int channel, unsigned int adc )

protected

Definition at line 203 of file TileCalibDrawerDat.h.

{
  unsigned int idx = channel*getNGains() + adc;
  return static_cast<T*>(TileCalibDrawerBase::getAddress(idx));
}

getAddress() [4/4]

template<class T>

const T * TileCalibDrawerDat< T >::getAddress ( unsigned int channel, unsigned int adc ) const

protected

Returns a pointer to the first value for the specified channel & ADC.

Parameters

channel	The channel number; If channel number >= getNChans() it is reset to channel % (maximum number of channels in drawer) if channel number > (maximum number of channels in drawer) otherwise it is reset to 0 without warning (default policy)
adc	The gain index; if >= getNGains() it is reset to 0 without warning (default policy)

Definition at line 194 of file TileCalibDrawerDat.h.

{
  unsigned int idx = channel*getNGains() + adc;
  return static_cast<const T*>(TileCalibDrawerBase::getAddress(idx));
}

getAuthor()

std::string TileCalibDrawerBase::getAuthor ( ) const

inherited

Returns the comment author.

Definition at line 147 of file TileCalibDrawerBase.cxx.

{
  if(!getCommentSizeUint32()) return std::string("");
  const char* iBeg =
    reinterpret_cast<const char*>(m_blobStart32 + m_hdrSize32     +
                                  getNObjs()*getObjSizeUint32()   +
                                  sizeof(uint64_t)/sizeof(uint32_t));
  return std::string(iBeg);
}

getBlobSize()

long TileCalibDrawerBase::getBlobSize ( ) const

inlineinherited

Returns the BLOB size in units of bytes.

Definition at line 92 of file TileCalibDrawerBase.h.

{ return m_blobSize32 * sizeof(uint32_t); } 

getBlobSize32()

long TileCalibDrawerBase::getBlobSize32 ( ) const

inlineinherited

Returns the BLOB size in units of uint32_t.

Definition at line 94 of file TileCalibDrawerBase.h.

{ return m_blobSize32; } 

getComment()

std::string TileCalibDrawerBase::getComment ( ) const

inherited

Returns the actual comment.

Definition at line 161 of file TileCalibDrawerBase.cxx.

{
  if(!getCommentSizeUint32()) return std::string("");
  const char* iBeg =
    reinterpret_cast<const char*>(m_blobStart32 + m_hdrSize32     +
                                  getNObjs()*getObjSizeUint32()   +
                                  sizeof(uint64_t)/sizeof(uint32_t));
  const char* iEnd = iBeg + getCommentSizeChar();
  iBeg = std::find(iBeg,iEnd,0);
  return std::string(++iBeg);
}

getCommentSizeChar()

uint32_t TileCalibDrawerBase::getCommentSizeChar ( ) const

inlineinherited

Returns the space occupied by the comment fields in units of chars.

Definition at line 112 of file TileCalibDrawerBase.h.

{return getCommentSizeUint32()*sizeof(uint32_t);}

getCommentSizeUint32()

uint32_t TileCalibDrawerBase::getCommentSizeUint32 ( ) const

inherited

Returns the space occupied by the comment fields in units of uint32_t.

getData()

template<class T>

T TileCalibDrawerDat< T >::getData	(	unsigned int	channel,
		unsigned int	adc,
		unsigned int	idx ) const

Returns a single T belonging to a channel/ADC.

Parameters

adc	The gain index; if >= getNGains() it is reset to 0 without warning (default policy)
idx	The index of the requested value

Definition at line 140 of file TileCalibDrawerDat.h.

{
  if(idx>=getObjSizeUint32()){
    throw TileCalib::IndexOutOfRange("TileCalibDrawerDat::getData",idx,getObjVersion());
  }
 
  //=== Tile Default Policy
 
  if(channel >= getNChans()) {
    if (channel <= TileCalibUtils::MAX_CHAN) {
      channel = 0;
    } else {
      channel = channel % TileCalibUtils::MAX_CHAN;
      if (channel >= getNChans()) channel = 0;
    }
  }
 
  if(adc >= getNGains()) {adc = 0;}
 
  return getAddress(channel,adc)[idx];
}

getDate()

std::string TileCalibDrawerBase::getDate ( ) const

inherited

Returns the date of the comment as string (derived from timestamp)

Definition at line 176 of file TileCalibDrawerBase.cxx.

{
  if(!getCommentSizeUint32()) return std::string("");
  ::time_t timeStamp = getTimeStamp();
  char buf[32];
  char* iBeg = ::ctime_r(&timeStamp, buf);
  char* iEnd = iBeg;
  while(*iEnd!='\n'){++iEnd;}
  return std::string(iBeg,iEnd-iBeg);
}

getFullComment()

std::string TileCalibDrawerBase::getFullComment ( ) const

inherited

Returns a formated string build from all comment fields.

Definition at line 190 of file TileCalibDrawerBase.cxx.

{
  if(!getCommentSizeUint32()) return std::string("");
  return getAuthor()+" ("+getDate()+"): "+getComment();
}

getNChans()

uint16_t TileCalibDrawerBase::getNChans ( ) const

inherited

Returns the number of channels stored in the BLOB.

getNGains()

uint16_t TileCalibDrawerBase::getNGains ( ) const

inherited

Returns the number of gains stored for each channel.

getNObjs()

uint32_t TileCalibDrawerBase::getNObjs ( ) const

inherited

Returns the number of data objects stored int the BLOB.

getObjSizeByte()

uint32_t TileCalibDrawerBase::getObjSizeByte ( ) const

inlineinherited

Returns the size of a data object in units of bytes.

Definition at line 102 of file TileCalibDrawerBase.h.

{return getObjSizeUint32()*sizeof(uint32_t);}

getObjSizeUint32()

uint32_t TileCalibDrawerBase::getObjSizeUint32 ( ) const

inherited

Returns the size of a data object in units of uint32_t.

getObjType()

uint16_t TileCalibDrawerBase::getObjType ( ) const

inherited

Returns the BLOB object type.

getObjVersion()

uint16_t TileCalibDrawerBase::getObjVersion ( ) const

inherited

Returns the BLOB object version.

getTimeStamp()

uint64_t TileCalibDrawerBase::getTimeStamp ( ) const

inherited

Returns the unix timestamp of the comment (seconds since 1.1.1970)

getType()

virtual uint16_t TileCalibDrawerBase::getType ( ) const

inlinevirtualinherited

Returns TileCalibDrawer::BASE.

Reimplemented in TileCalibDrawerBch, TileCalibDrawerCmt, TileCalibDrawerFlt, TileCalibDrawerInt, and TileCalibDrawerOfc.

Definition at line 80 of file TileCalibDrawerBase.h.

{return TileCalibType::BASE;}

init()

template<class T>

void TileCalibDrawerDat< T >::init	(	const DefType &	def,
		uint16_t	nChans,
		uint16_t	objVers,
		const std::string &	author = "",
		const std::string &	comment = "",
		uint64_t	timeStamp = 0 )

Initializing function.

Parameters

def	A reference to a DefType object, specifying the inital layout and values
nChans	Number of channels to create
objType	Type of the (derived class) object
objVers	Version of the (derived class) object
author	String containing the author user id
comment	String containing the actual comment
timeStamp	Unix time stamp (if 0, current time is used)

Definition at line 107 of file TileCalibDrawerDat.h.

{
  uint16_t nGains   = def.size();
  uint32_t objSize  = nGains>0 ? def.begin()->size() * sizeof(T)/sizeof(uint32_t) : 0; 
  uint32_t nObjs    = nChans*nGains;
 
  //=== ensure all gains have the same object size
  for(unsigned int iGain=0; iGain<nGains; ++iGain){
    unsigned int thisSize = def[iGain].size()*sizeof(T)/sizeof(uint32_t);
    if( thisSize != objSize ){
      throw TileCalib::SizeConflict("TileCalibDrawerDat<T>::init",thisSize,objSize);
    }
  }
  
  //=== create blob
  createBlob(getType(), objVers, objSize, nObjs, nChans, nGains, author, comment, timeStamp);
 
  //=== fill the blob with default
  for(unsigned int channel=0; channel<nChans; ++channel){
    for(unsigned int adc=0; adc<nGains; ++adc){
      setData(channel, adc, def[adc]);
    }
  }
}

setData() [1/2]

template<class T>

void TileCalibDrawerDat< T >::setData	(	unsigned int	channel,
		unsigned int	adc,
		const std::vector< T > &	data )

Sets a number of Ts stored in the input vector.

Parameters

channel	The channel number
adc	The gain index
data	A vector containing the values to be set

Definition at line 184 of file TileCalibDrawerDat.h.

{
  for(typename std::vector<T>::const_iterator i=data.begin(); i!=data.end(); ++i){
    setData(channel,adc,i-data.begin(),*i);
  }
}

setData() [2/2]

template<class T>

void TileCalibDrawerDat< T >::setData	(	unsigned int	channel,
		unsigned int	adc,
		unsigned int	idx,
		T	data )

Sets a single T belonging to a channel/ADC.

Parameters

channel	The channel number
adc	The gain index
idx	The index of the value to set
data	The data value to set

Definition at line 165 of file TileCalibDrawerDat.h.

{
  //=== check for out of bounds
  if(channel >= getNChans()){
    throw TileCalib::IndexOutOfRange("TileCalibDrawerDat::getAddress(channel)",channel,getNChans());
  }
  if(adc>=getNGains()){
    throw TileCalib::IndexOutOfRange("CaloCalibDrawerDat::getAddress(gain)",adc,getNGains());
  }
  if(idx>=getObjSizeUint32()){
    throw TileCalib::IndexOutOfRange("TileCalibDrawerDat::getData",idx,getObjVersion());
  }
 
  getAddress(channel,adc)[idx] = data;
}

Member Data Documentation

m_blob

const coral::Blob* TileCalibDrawerBase::m_blob

privateinherited

Const reference to the BLOB (always there)

Definition at line 176 of file TileCalibDrawerBase.h.

m_blob_nc

coral::Blob* TileCalibDrawerBase::m_blob_nc

privateinherited

Non-const reference to the BLOB.

(Only present if we were created with a non-const blob.)

Definition at line 174 of file TileCalibDrawerBase.h.

m_blobSize32

uint64_t TileCalibDrawerBase::m_blobSize32

privateinherited

Cache blob size in units of uint32_t.

Definition at line 182 of file TileCalibDrawerBase.h.

m_blobStart16

const uint16_t* TileCalibDrawerBase::m_blobStart16

privateinherited

Cache blob starting address as uint_16t*.

Definition at line 180 of file TileCalibDrawerBase.h.

m_blobStart32

const uint32_t* TileCalibDrawerBase::m_blobStart32

privateinherited

Cache blob starting address as uint_32t*.

Definition at line 178 of file TileCalibDrawerBase.h.

m_hdrSize32

const unsigned int TileCalibDrawerBase::m_hdrSize32 = 5

staticinherited

The header size in units of uint32_t.

Definition at line 138 of file TileCalibDrawerBase.h.

m_isBlobOwner

bool TileCalibDrawerBase::m_isBlobOwner

privateinherited

Is this TileCalibDrawer owner of the BLOB.

Definition at line 184 of file TileCalibDrawerBase.h.

---

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

• TileCalibDrawerDat.h