TileCalibDrawerCmt Class Reference

Class to store comments in BLOB without any data. More...

#include <TileCalibDrawerCmt.h>

Inheritance diagram for TileCalibDrawerCmt:

Collaboration diagram for TileCalibDrawerCmt:

Public Member Functions
virtual	~TileCalibDrawerCmt ()
	Dtor.
virtual uint16_t	getType () const
	Returns TileCalibType::CMT.
void	init (const std::string &author, const std::string &comment="", uint64_t timeStamp=0)
	Initializing a TileCalibDrawerCmt.
virtual void	dump () const
	Print the header to std::cout.
virtual void	dump (std::ostream &stm) const
	Print the header.
virtual void	clone (const TileCalibDrawerBase &other)
	Initialzes Blob with content of other Blob.
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 Member Functions
static const TileCalibDrawerCmt *	getInstance (const coral::Blob &blob)
	Returns a pointer to a const TileCalibDrawerCmt.
static TileCalibDrawerCmt *	getInstance (coral::Blob &blob, const std::string &author, const std::string &comment="", uint64_t timeStamp=0)
	Returns a pointer to a non-const TileCalibDrawerCmt.

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

Protected Member Functions
	TileCalibDrawerCmt (const coral::Blob &blob)
	Ctor used when interpreting an already existing BLOB.
	TileCalibDrawerCmt (coral::Blob &blob)
	Ctor (non-const).
uint32_t	createBlob (uint16_t objType, uint16_t objVersion, uint32_t objSizeUint32, uint32_t nObjs, uint16_t nChans, uint16_t nGains, std::string_view author="", std::string_view 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

Class to store comments in BLOB without any data.

Author

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

This is a specialesed TileCalibDrawer class that holds only the comment fields but no calibration data. It should only be stored in the COOL comment channel (see TileCalibUtils class).

Definition at line 20 of file TileCalibDrawerCmt.h.

Constructor & Destructor Documentation

~TileCalibDrawerCmt()

virtual TileCalibDrawerCmt::~TileCalibDrawerCmt ( )

inlinevirtual

Dtor.

Definition at line 23 of file TileCalibDrawerCmt.h.

{}

TileCalibDrawerCmt() [1/2]

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

protected

Ctor used when interpreting an already existing BLOB.

Parameters

blob	A const reference to the coral::Blob to interpret.

Definition at line 35 of file TileCalibDrawerCmt.cxx.

  : TileCalibDrawerBase(blob)
{
  //=== no type check here
}

TileCalibDrawerCmt() [2/2]

TileCalibDrawerCmt::TileCalibDrawerCmt ( coral::Blob & blob )

protected

Ctor (non-const).

Definition at line 44 of file TileCalibDrawerCmt.cxx.

  : TileCalibDrawerBase(blob)
{
  //=== no type check here
}

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 75 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, std::string_view author = "", std::string_view 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 88 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); 
    auto 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]

virtual void TileCalibDrawerCmt::dump ( ) const

inlinevirtual

Print the header to std::cout.

Reimplemented from TileCalibDrawerBase.

Definition at line 48 of file TileCalibDrawerCmt.h.

{ dumpHeader(std::cout); }

dump() [2/2]

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

inlinevirtual

Print the header.

Parameters

stm	The stream to print to

Reimplemented from TileCalibDrawerBase.

Definition at line 51 of file TileCalibDrawerCmt.h.

{ dumpHeader(stm); }

dumpHeader()

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

protectedinherited

Prints the BLOB header summary information.

Parameters

stm	output stream to use

Definition at line 201 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/2]

void * TileCalibDrawerBase::getAddress ( unsigned int iEle )

inherited

getAddress() [2/2]

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

inherited

Returns start address of iEle-th basic unit.

Parameters

iEle	sequential basic unit number

getAuthor()

std::string TileCalibDrawerBase::getAuthor ( ) const

inherited

Returns the comment author.

Definition at line 148 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 94 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 96 of file TileCalibDrawerBase.h.

{ return m_blobSize32; } 

getComment()

std::string TileCalibDrawerBase::getComment ( ) const

inherited

Returns the actual comment.

Definition at line 162 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 114 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.

getDate()

std::string TileCalibDrawerBase::getDate ( ) const

inherited

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

Definition at line 177 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 191 of file TileCalibDrawerBase.cxx.

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

getInstance() [1/2]

const TileCalibDrawerCmt * TileCalibDrawerCmt::getInstance ( const coral::Blob & blob )

static

Returns a pointer to a const TileCalibDrawerCmt.

Definition at line 24 of file TileCalibDrawerCmt.cxx.

{
  //=== const Blob needs to be correctly formated
  if(blob.size()<static_cast<long>(m_hdrSize32)){
    throw TileCalib::InvalidBlob("TileCalibDrawerCmt::getInstance");
  }
  return (new TileCalibDrawerCmt(blob));
}

getInstance() [2/2]

TileCalibDrawerCmt * TileCalibDrawerCmt::getInstance ( coral::Blob & blob, const std::string & author, const std::string & comment = "", uint64_t timeStamp = 0 )

static

Returns a pointer to a non-const TileCalibDrawerCmt.

Parameters

blob	Reference to a coral::Blob
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 11 of file TileCalibDrawerCmt.cxx.

{
  TileCalibDrawerCmt* calibDrawer = new TileCalibDrawerCmt(blob);
  calibDrawer->init(author,comment,timeStamp);
  return calibDrawer;
}

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 104 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 TileCalibDrawerCmt::getType ( ) const

inlinevirtual

Returns TileCalibType::CMT.

Reimplemented from TileCalibDrawerBase.

Definition at line 26 of file TileCalibDrawerCmt.h.

{return TileCalibType::CMT;}

init()

void TileCalibDrawerCmt::init	(	const std::string &	author,
		const std::string &	comment = "",
		uint64_t	timeStamp = 0 )

Initializing a TileCalibDrawerCmt.

Parameters

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 54 of file TileCalibDrawerCmt.cxx.

{
  createBlob(TileCalibType::CMT,0,0,0,0,0,author,comment,timeStamp);
}

Member Data Documentation

m_blob

const coral::Blob* TileCalibDrawerBase::m_blob

privateinherited

Const reference to the BLOB (always there).

Definition at line 178 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 176 of file TileCalibDrawerBase.h.

m_blobSize32

uint64_t TileCalibDrawerBase::m_blobSize32

privateinherited

Cache blob size in units of uint32_t.

Definition at line 184 of file TileCalibDrawerBase.h.

m_blobStart16

const uint16_t* TileCalibDrawerBase::m_blobStart16

privateinherited

Cache blob starting address as uint_16t*.

Definition at line 182 of file TileCalibDrawerBase.h.

m_blobStart32

const uint32_t* TileCalibDrawerBase::m_blobStart32

privateinherited

Cache blob starting address as uint_32t*.

Definition at line 180 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 140 of file TileCalibDrawerBase.h.

m_isBlobOwner

bool TileCalibDrawerBase::m_isBlobOwner

privateinherited

Is this TileCalibDrawer owner of the BLOB.

Definition at line 186 of file TileCalibDrawerBase.h.

---

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

• TileCalibDrawerCmt.h
• TileCalibDrawerCmt.cxx