CaloCondBlobBase Class Reference

This class provides the core BLOB infrastructure. More...

#include <CaloCondBlobBase.h>

Inheritance diagram for CaloCondBlobBase:

Collaboration diagram for CaloCondBlobBase:

Public Member Functions
virtual	~CaloCondBlobBase ()
	Dtor.
	CaloCondBlobBase (const CaloCondBlobBase &other)
	Copy Ctor.
CaloCondBlobBase &	operator= (const CaloCondBlobBase &other)
	Assignment operator.
virtual uint16_t	getType () const
	Returns CaloCondDrawer::BASE.
virtual void	dump () const
	Prints the BLOB header summary information to std::cout.
virtual void	dump (std::ostream &stm) const
	Prints the BLOB header summary information.
long	getBlobSize () const
	Returns the BLOB size.
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.
uint32_t	getNChans () const
	Returns the number of channels stored in the BLOB.
uint32_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.
unsigned int	getHdrSize () const
	Returns the size of the header in units of uint32_t.
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)

Protected Member Functions
	CaloCondBlobBase (const coral::Blob &blob)
	Ctor for const blob.
	CaloCondBlobBase (coral::Blob &blob)
	Ctor for non-const blob.
uint32_t	createBlob (uint16_t objType, uint16_t objVersion, uint32_t objSizeUint32, uint32_t nObjs, uint32_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.

Protected Attributes
const void *	m_pDataStart

Private Member Functions
	CaloCondBlobBase (coral::Blob *blob_nc, const coral::Blob *blob)
	Internal ctor.
const uint32_t *	getBlobStart () const
	Returns the BLOB start address as uint32_t pointer.
uint32_t *	getBlobStart ()
	Returns the BLOB start address as uint32_t pointer.

Static Private Member Functions
static uint32_t	packGainAndNchans (const uint32_t gain, const uint32_t nChans)
static uint32_t	unpacknGains (const uint32_t gainAndnChans)
static uint32_t	unpacknChans (const uint32_t gainAndnChans)

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)
bool	m_isBlobOwner
	Do I own the BLOB?
unsigned	m_sizeOfObj
	Chache of some frequently-used numbers.
unsigned	m_nChans
unsigned	m_nGains

Detailed Description

This class provides the core BLOB infrastructure.

Author

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

All data storage classes inherit from this class. It provides the infrastructure to store and retrieve units of conditions data associated with one channel/gain ("data object") by implementing a common BLOB header. This header holds the following information:

• The type of the object stored in the BLOB (see CaloCondType class for known types)
• The version of the type (allows for schema evolution)
• The size of a data object in units of uint32_t (4 bytes)
• The total number of data objects
• The number of channels stored in the blob
• The number of gains stored for each channel
• The number of uint32_t used to store comment information (after the actual blob data)

A data object contains all conditions data related to one channel/gain (depending on data stored on channel or adc level), for example 5 floats. The conditions data units themselves must be build from objects of 32 bit length, i.e. available types are float, uint32_t and int32_t.

Definition at line 43 of file CaloCondBlobBase.h.

Constructor & Destructor Documentation

~CaloCondBlobBase()

CaloCondBlobBase::~CaloCondBlobBase ( )

virtual

Dtor.

Definition at line 43 of file CaloCondBlobBase.cxx.

{
  //=== delete the coral::Blob if owner
  if(m_isBlobOwner) {delete m_blob;}
}

CaloCondBlobBase() [1/4]

CaloCondBlobBase::CaloCondBlobBase

(

const CaloCondBlobBase &

other

)

Copy Ctor.

Definition at line 51 of file CaloCondBlobBase.cxx.

  : m_blob_nc(new coral::Blob(*other.m_blob))
  , m_blob (m_blob_nc)
  , m_isBlobOwner(true),
    m_sizeOfObj(other.getObjSizeUint32()),
    m_nChans(other.getNChans()),
    m_nGains(other.getNChans()),
    m_pDataStart(static_cast<const void*>(getBlobStart()+getHdrSize()))
{
}

CaloCondBlobBase() [2/4]

CaloCondBlobBase::CaloCondBlobBase ( const coral::Blob & blob )

protected

Ctor for const blob.

Definition at line 31 of file CaloCondBlobBase.cxx.

  : CaloCondBlobBase (nullptr, &blob)
{
}

CaloCondBlobBase() [3/4]

CaloCondBlobBase::CaloCondBlobBase ( coral::Blob & blob )

protected

Ctor for non-const blob.

Definition at line 36 of file CaloCondBlobBase.cxx.

  : CaloCondBlobBase (&blob, &blob)
{
}

CaloCondBlobBase() [4/4]

CaloCondBlobBase::CaloCondBlobBase ( coral::Blob * blob_nc, const coral::Blob * blob )

private

Internal ctor.

Definition at line 13 of file CaloCondBlobBase.cxx.

  : m_blob_nc(blob_nc),
    m_blob(blob)
  , m_isBlobOwner(false),m_sizeOfObj(0),m_nChans(0),m_nGains(0), m_pDataStart(nullptr) 
{
  if(uint64_t(m_blob->size())>=getHdrSize()*sizeof(uint32_t)) {
    m_sizeOfObj=static_cast<const uint32_t*>(m_blob->startingAddress())[1];
    //m_nChans=static_cast<uint16_t*>(m_blob->startingAddress())[6];
    //m_nGains=static_cast<uint16_t*>(m_blob->startingAddress())[7];
    const CaloCondBlobBase& this_c = *this;
    m_nChans=unpacknChans(this_c.getBlobStart()[3]);
    m_nGains=unpacknGains(this_c.getBlobStart()[3]);
    m_pDataStart=static_cast<const void*>(this_c.getBlobStart()+getHdrSize());
    //std::cout << "CaloCondBlobObj: nChans=" << m_nChans << " nGains=" << m_nGains << std::endl;
  }
  }

Member Function Documentation

createBlob()

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

protected

(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 84 of file CaloCondBlobBase.cxx.

{
  
  //=== blob data length including header in bytes
  const uint32_t dataSizeByte = (getHdrSize()+objSizeUint32*nObjs) * sizeof(uint32_t);
  
  //=== calculate comment length, including two ASCII NULLs to end text fields
  uint32_t commentSizeChar(0);
  if(!author.empty() || !comment.empty() || 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
  const uint32_t blobSizeInBytes = dataSizeByte+commentSizeChar;
  m_blob_nc->resize(blobSizeInBytes);
  
  //=== fill header
  reinterpret_cast<uint16_t*>(getBlobStart())[0] = objType;
  reinterpret_cast<uint16_t*>(getBlobStart())[1] = objVersion;
  getBlobStart()[1] = objSizeUint32;
  m_sizeOfObj=objSizeUint32;
  getBlobStart()[2] = nObjs;
  getBlobStart()[3] = packGainAndNchans(nGains,nChans);
  m_nChans=nChans;
  m_nGains=nGains;
  getBlobStart()[4] = commentSizeChar/sizeof(uint32_t);
  
  //==== fill comment fields
  if(commentSizeChar){
    if(!timeStamp) timeStamp = ::time(nullptr);
    uint8_t* pChar = reinterpret_cast<uint8_t*> (getBlobStart()+dataSizeByte/sizeof(uint32_t));
    CxxUtils::set_unaligned<uint64_t> (pChar, timeStamp);
    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;
  }
 
  m_pDataStart=static_cast<const void*>(getBlobStart()+getHdrSize());
  return (blobSizeInBytes/sizeof(uint32_t));
}

dump() [1/2]

virtual void CaloCondBlobBase::dump ( ) const

inlinevirtual

Prints the BLOB header summary information to std::cout.

Reimplemented in CaloCondBlobDat< T >, and CaloCondBlobDat< float >.

Definition at line 56 of file CaloCondBlobBase.h.

{ dumpHeader(std::cout); } 

dump() [2/2]

virtual void CaloCondBlobBase::dump ( std::ostream & stm ) const

inlinevirtual

Prints the BLOB header summary information.

Parameters

stm	The output stream to use

Reimplemented in CaloCondBlobDat< T >.

Definition at line 59 of file CaloCondBlobBase.h.

{dumpHeader(stm);} 

dumpHeader()

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

protected

Prints the BLOB header summary information.

Parameters

stm	output stream to use

Definition at line 229 of file CaloCondBlobBase.cxx.

{
  stm << "This is a " << CaloCondType::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/2]

void * CaloCondBlobBase::getAddress ( unsigned int iEle )

inline

Definition at line 272 of file CaloCondBlobBase.h.

{
  if(iEle>=getNObjs()){ 
    throw CaloCond::IndexOutOfRange("CaloCondBlobBase::getAddress", iEle, getNObjs());
  }
  return static_cast<void*>
    ( getBlobStart() + getHdrSize() + getObjSizeUint32()*iEle );
}

getAddress() [2/2]

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

inline

Returns start address of iEle-th basic unit.

Parameters

iEle	sequential basic unit number

Definition at line 260 of file CaloCondBlobBase.h.

{
  if(iEle>=getNObjs()){ 
    throw CaloCond::IndexOutOfRange("CaloCondBlobBase::getAddress", iEle, getNObjs());
  }
  return static_cast<const void*>
    ( getBlobStart() + getHdrSize() + getObjSizeUint32()*iEle );
}

getAuthor()

std::string CaloCondBlobBase::getAuthor

(

)

const

Returns the comment author.

Definition at line 176 of file CaloCondBlobBase.cxx.

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

getBlobSize()

long CaloCondBlobBase::getBlobSize ( ) const

inline

Returns the BLOB size.

Definition at line 66 of file CaloCondBlobBase.h.

{return m_blob->size(); } 

getBlobStart() [1/2]

uint32_t * CaloCondBlobBase::getBlobStart ( )

inlineprivate

Returns the BLOB start address as uint32_t pointer.

Definition at line 186 of file CaloCondBlobBase.h.

{
  return static_cast<uint32_t*>(m_blob_nc->startingAddress());
}

getBlobStart() [2/2]

const uint32_t * CaloCondBlobBase::getBlobStart ( ) const

inlineprivate

Returns the BLOB start address as uint32_t pointer.

Definition at line 178 of file CaloCondBlobBase.h.

{
  return static_cast<const uint32_t*>(m_blob->startingAddress());
}

getComment()

std::string CaloCondBlobBase::getComment

(

)

const

Returns the actual comment.

Definition at line 190 of file CaloCondBlobBase.cxx.

{
  if(!getCommentSizeUint32()) return std::string("");
  const char* iBeg =
    reinterpret_cast<const char*>(getBlobStart()+getHdrSize()     +
                                  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 CaloCondBlobBase::getCommentSizeChar ( ) const

inline

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

Definition at line 84 of file CaloCondBlobBase.h.

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

getCommentSizeUint32()

uint32_t CaloCondBlobBase::getCommentSizeUint32 ( ) const

inline

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

Definition at line 250 of file CaloCondBlobBase.h.

{
  if(uint64_t(m_blob->size())<getHdrSize()*sizeof(uint32_t)) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::getCommentSizeUint32");
  return static_cast<const uint32_t*>(m_blob->startingAddress())[4];
}

getDate()

std::string CaloCondBlobBase::getDate

(

)

const

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

Definition at line 205 of file CaloCondBlobBase.cxx.

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

getFullComment()

std::string CaloCondBlobBase::getFullComment

(

)

const

Returns a formated string build from all comment fields.

Definition at line 219 of file CaloCondBlobBase.cxx.

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

getHdrSize()

unsigned int CaloCondBlobBase::getHdrSize ( ) const

inline

Returns the size of the header in units of uint32_t.

Definition at line 86 of file CaloCondBlobBase.h.

{return 5;}

getNChans()

uint32_t CaloCondBlobBase::getNChans ( ) const

inline

Returns the number of channels stored in the BLOB.

Definition at line 232 of file CaloCondBlobBase.h.

{
  return m_nChans;
}

getNGains()

uint32_t CaloCondBlobBase::getNGains ( ) const

inline

Returns the number of gains stored for each channel.

Definition at line 240 of file CaloCondBlobBase.h.

{
  return m_nGains;
 
 
}

getNObjs()

uint32_t CaloCondBlobBase::getNObjs ( ) const

inline

Returns the number of data objects stored int the BLOB.

Definition at line 222 of file CaloCondBlobBase.h.

{
  if(uint64_t(m_blob->size())<getHdrSize()*sizeof(uint32_t)) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::getNObjs");
  return static_cast<const uint32_t*>(m_blob->startingAddress())[2];
}

getObjSizeByte()

uint32_t CaloCondBlobBase::getObjSizeByte ( ) const

inline

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

Definition at line 74 of file CaloCondBlobBase.h.

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

getObjSizeUint32()

uint32_t CaloCondBlobBase::getObjSizeUint32 ( ) const

inline

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

Definition at line 214 of file CaloCondBlobBase.h.

{
  return m_sizeOfObj;
}

getObjType()

uint16_t CaloCondBlobBase::getObjType ( ) const

inline

Returns the BLOB object type.

Definition at line 194 of file CaloCondBlobBase.h.

{
  if(uint64_t(m_blob->size())<getHdrSize()*sizeof(uint32_t)) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::getObjType");
  return static_cast<const uint16_t*>(m_blob->startingAddress())[0];
}

getObjVersion()

uint16_t CaloCondBlobBase::getObjVersion ( ) const

inline

Returns the BLOB object version.

Definition at line 204 of file CaloCondBlobBase.h.

{
  if(uint64_t(m_blob->size())<getHdrSize()*sizeof(uint32_t)) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::getObjVersion");
  return static_cast<const uint16_t*>(m_blob->startingAddress())[1];
}

getTimeStamp()

uint64_t CaloCondBlobBase::getTimeStamp ( ) const

inline

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

Definition at line 284 of file CaloCondBlobBase.h.

{
  if(!getCommentSizeUint32()) return 0;
  auto p = reinterpret_cast<const uint8_t*>(getBlobStart()+getHdrSize() +
                                            getNObjs()*getObjSizeUint32());
  return CxxUtils::get_unaligned64 (p);
}

getType()

virtual uint16_t CaloCondBlobBase::getType ( ) const

inlinevirtual

Returns CaloCondDrawer::BASE.

Reimplemented in CaloCondBlobFlt.

Definition at line 53 of file CaloCondBlobBase.h.

{return CaloCondType::BASE;}

operator=()

CaloCondBlobBase & CaloCondBlobBase::operator=

(

const CaloCondBlobBase &

other

)

Assignment operator.

Definition at line 65 of file CaloCondBlobBase.cxx.

{
  //=== catch self-assignment
  if(&other == this) {return *this;}
  if (m_isBlobOwner) delete m_blob;
  m_blob = other.m_blob;
  m_blob_nc = other.m_blob_nc;
  m_isBlobOwner = false;
  m_sizeOfObj=static_cast<const uint32_t*>(m_blob->startingAddress())[1];
  m_nChans=unpacknChans(getBlobStart()[3]);
  m_nGains=unpacknGains(getBlobStart()[3]);
  m_pDataStart=static_cast<const void*>(getBlobStart()+getHdrSize());
  return *this;
}

packGainAndNchans()

uint32_t CaloCondBlobBase::packGainAndNchans ( const uint32_t gain, const uint32_t nChans )

staticprivate

Definition at line 139 of file CaloCondBlobBase.cxx.

                                                                                       {
 
  if (gain>0x7F) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::packGainAndNchans: Gain too large");
 
  if (nChans>0xFFFFFF) 
    throw CaloCond::InvalidBlob("CaloCondBlobBase::packGainAndNchans: Number of channels too large");
 
  return 0x80000000 | (gain << 24) | nChans;
}

unpacknChans()

uint32_t CaloCondBlobBase::unpacknChans ( const uint32_t gainAndnChans )

staticprivate

Definition at line 160 of file CaloCondBlobBase.cxx.

                                                                    {
  if (gainAndnChans & 0x80000000) { //new version: 24 bytes for the nChans, 7 for the gain
    //std::cout << "CaloCondBlobBase: Reading nChans from new version" << std::endl;
    return gainAndnChans & 0xFFFFFF;
  }
  else //Old version: 16 bits for nChans
    //std::cout << "CaloCondBlobBase: Reading nChangs from old version" << std::endl;
    return gainAndnChans & 0xFFFF;
} 

unpacknGains()

uint32_t CaloCondBlobBase::unpacknGains ( const uint32_t gainAndnChans )

staticprivate

Definition at line 150 of file CaloCondBlobBase.cxx.

                                                                    {
  if (gainAndnChans & 0x80000000) { //new version: 24 bytes for the nChans, 7 for the gain
    //std::cout << "CaloCondBlobBase: Reading gain from new version" << std::endl;
    return (gainAndnChans>>24) & 0x7F;
  }
  else //Old version: 16 bigs for gain
    //std::cout << "CaloCondBlobBase: Reading gain from old version" << std::endl;
    return (gainAndnChans>>16) & 0xFFFF;
} 

Member Data Documentation

m_blob

const coral::Blob* CaloCondBlobBase::m_blob

private

Const reference to the BLOB (always there)

Definition at line 161 of file CaloCondBlobBase.h.

m_blob_nc

coral::Blob* CaloCondBlobBase::m_blob_nc

private

Non-const reference to the BLOB.

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

Definition at line 158 of file CaloCondBlobBase.h.

m_isBlobOwner

bool CaloCondBlobBase::m_isBlobOwner

private

Do I own the BLOB?

Definition at line 164 of file CaloCondBlobBase.h.

m_nChans

unsigned CaloCondBlobBase::m_nChans

private

Definition at line 168 of file CaloCondBlobBase.h.

m_nGains

unsigned CaloCondBlobBase::m_nGains

private

Definition at line 169 of file CaloCondBlobBase.h.

m_pDataStart

const void* CaloCondBlobBase::m_pDataStart

protected

Definition at line 171 of file CaloCondBlobBase.h.

m_sizeOfObj

unsigned CaloCondBlobBase::m_sizeOfObj

private

Chache of some frequently-used numbers.

Definition at line 167 of file CaloCondBlobBase.h.

---

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

• CaloCondBlobBase.h
• CaloCondBlobBase.cxx