VP1SGContentsHelper Class Reference

#include <VP1SGContentsHelper.h>

Inheritance diagram for VP1SGContentsHelper:

Collaboration diagram for VP1SGContentsHelper:

Public Member Functions
	VP1SGContentsHelper (IVP1System *, const bool detStore=false)
	VP1SGContentsHelper (StoreGateSvc *)
virtual	~VP1SGContentsHelper ()
template<typename T >
QStringList	getKeys () const
QStringList	getKeys (const CLID &id) const
template<typename T >
bool	contains (const QString &key) const
bool	contains (const CLID &id, const QString &key) const
QList< CLID >	getPossibleCLIDs () const
void	setSystemBasePointer (IVP1System *sys)
void	message (const QString &) const
void	message (const QStringList &, const QString &addtoend="") const
void	message (const QString &addtostart, const QStringList &, const QString &addtoend="") const
void	messageDebug (const QString &) const
void	messageDebug (const QStringList &, const QString &addtoend="") const
void	messageDebug (const QString &addtostart, const QStringList &, const QString &addtoend="") const
void	messageVerbose (const QString &) const
void	messageVerbose (const QStringList &, const QString &addtoend="") const
void	messageVerbose (const QString &addtostart, const QStringList &, const QString &addtoend="") const
IVP1System *	systemBase () const
QString	helperClassName () const

Static Public Member Functions
static bool	verbose ()
static void	warnUndeletedInstances ()
static QString	str (const QString &s)
static QString	str (const char *c)
static QString	str (const bool b)
static QString	str (const QColor &)
static QString	str (const SbColor &)
static QString	str (const VP1Interval &)
static QString	str (const SbVec2d &)
static QString	str (const SbVec2f &)
static QString	str (const SbVec2s &)
static QString	str (const SbVec3d &)
static QString	str (const SbVec3f &)
static QString	str (const SbVec3s &)
static QString	str (const SbVec4d &)
static QString	str (const SbVec4f &)
static QString	str (short int n)
static QString	str (unsigned short int n)
static QString	str (long n)
static QString	str (ulong n)
static QString	str (int n)
static QString	str (uint n)
static QString	str (qlonglong n)
static QString	str (qulonglong n)
static QString	str (const double &d)
static QString	str (const float &f)
static QString	str (const void *)
template<class T >
static QString	str (const T *t)
template<class T >
static QString	str (const QFlags< T > &f)
template<class T >
static QString	str (const HepGeom::BasicVector3D< T > &t)
static QString	str (const Amg::Vector3D &t)
template<class T >
static QString	str (const QList< T > &t)

Protected Member Functions
void	setHelperClassName (const QString &n)

Private Attributes
StoreGateSvc *	m_sg
QString	m_helpername
IVP1System *	m_system

Static Private Attributes
static const bool	s_vp1verbose = VP1QtUtils::environmentVariableIsOn("VP1_VERBOSE_OUTPUT")

Detailed Description

Definition at line 26 of file VP1SGContentsHelper.h.

Constructor & Destructor Documentation

VP1SGContentsHelper() [1/2]

VP1SGContentsHelper::VP1SGContentsHelper	(	IVP1System *	sys,
		const bool	detStore = false
	)

Definition at line 25 of file VP1SGContentsHelper.cxx.

  : VP1HelperClassBase(sys,"VP1SGContentsHelper"), m_sg(sys?(detStore?sys->detectorStore():sys->storeGate()):0)
{
  if (!sys)
    message("ERROR: Received null system pointer (won't be able to get storeGate pointer either)");
  else if (!m_sg)
    message("ERROR: Could not get "+QString(detStore?"storeGate":"detectorStore")+" pointer from system");
}

VP1SGContentsHelper() [2/2]

VP1SGContentsHelper::VP1SGContentsHelper

(

StoreGateSvc *

sg

)

Definition at line 35 of file VP1SGContentsHelper.cxx.

  : VP1HelperClassBase(0,"VP1SGContentsHelper"), m_sg(sg)
{
  if (!sg)
    message("ERROR: Received null storegate pointer");
}

~VP1SGContentsHelper()

virtual VP1SGContentsHelper::~VP1SGContentsHelper ( )

inlinevirtual

Definition at line 31 of file VP1SGContentsHelper.h.

{}

Member Function Documentation

contains() [1/2]

bool VP1SGContentsHelper::contains	(	const CLID &	id,
		const QString &	key
	)		const

Definition at line 43 of file VP1SGContentsHelper.cxx.

{
  if (VP1Msg::verbose())
    messageVerbose("contains(..) called for key = "+key);
  if (!m_sg) {
    message("ERROR: Does not have StoreGate pointer - returning false.");
    return false;
  }
  if (key.isEmpty()) {
    message("ERROR: Passed key is empty. Returning false.");
    return false;
  }
  bool contains = false;
  bool exception = true;
  try {
    contains = m_sg->contains(id,key.toStdString());
    exception = false;
  } catch (const std::runtime_error& e) {
    exception = true;
  }
  if (exception) {
    message("ERROR: Exception thrown during call to StoreGateSvc::contains(..). Returning false.");
    return false;
  }
  if (VP1Msg::verbose())
    messageVerbose("contains(..) returning "+QString(contains?"true":"false"));
  return contains;
}

contains() [2/2]

template<typename T >

bool VP1SGContentsHelper::contains ( const QString &  key ) const

inline

Definition at line 61 of file VP1SGContentsHelper.h.

{
  return contains(ClassID_traits<T>::ID(),key);
}

getKeys() [1/2]

template<typename T >

QStringList VP1SGContentsHelper::getKeys

inline

Definition at line 55 of file VP1SGContentsHelper.h.

{
  return getKeys(ClassID_traits<T>::ID());
}

getKeys() [2/2]

QStringList VP1SGContentsHelper::getKeys

(

const CLID &

id

)

const

Definition at line 73 of file VP1SGContentsHelper.cxx.

{
  messageVerbose("getKeys(..) called");
  if (!m_sg) {
    message("ERROR: Does not have StoreGate pointer - returning empty key list");
    return QStringList();
  }
  QStringList l;
 
  std::vector<std::string> keys;
 
  bool exception = true;
  try {
    m_sg->keys(id, keys);
    exception = false;
  } catch (const std::runtime_error& e) {
    exception = true;
  }
  if (exception) {
    message("ERROR: Exception thrown during call to StoreGateSvc::keys(..)");
    return QStringList();
  }
  std::vector<std::string>::const_iterator it(keys.begin()), itE(keys.end());
  for (;it!=itE;++it) {
    if (it->empty())
      continue;
    if (contains(id,it->c_str()))
      l << it->c_str();
    else if (VP1Msg::verbose())
      messageVerbose("NB: StoreGateSvc::keys() included '"+QString(it->c_str())
             +"' but StoreGateSvc::contains("+QString(it->c_str())+") returns false." );
  }
  if (VP1Msg::verbose()) {
    messageVerbose("returning "+QString::number(l.count())+" keys:");
    messageVerbose("      => ",l);
  }
  return l;
}

getPossibleCLIDs()

QList< CLID > VP1SGContentsHelper::getPossibleCLIDs

(

)

const

Definition at line 113 of file VP1SGContentsHelper.cxx.

{
  messageVerbose("getPossibleCLIDs(..) called");
  QList<CLID> l;
  if (!m_sg) {
    message("ERROR: Does not have StoreGate pointer - returning empty key list");
    return l;
  }
 
  for (CLID id : m_sg->clids())
    l << id;
  return l;
}

helperClassName()

QString VP1HelperClassBase::helperClassName ( ) const

inlineinherited

Definition at line 51 of file VP1HelperClassBase.h.

{ return m_helpername; }

message() [1/3]

void VP1HelperClassBase::message ( const QString &  str ) const

inherited

Definition at line 49 of file VP1HelperClassBase.cxx.

{
  if (m_helpername.isEmpty()) {
    if (m_system)
      m_system->message(str);
    else
      std::cout<<VP1Msg::prefix_msg()<<" [nameless helper class]: "<<str.toStdString()<<std::endl;
  } else {
    if (m_system)
      m_system->message("["+m_helpername+"] " + str);
    else
      std::cout<<VP1Msg::prefix_msg()<<" ["<<m_helpername.toStdString()<<"]: "<<str.toStdString()<<std::endl;
  }
}

message() [2/3]

void VP1HelperClassBase::message ( const QString &  addtostart, const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 131 of file VP1HelperClassBase.cxx.

{
  if (addtostart.isEmpty()) {
    message(l,addtoend);
    return;
  }
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      message(addtostart+s);
  } else {
    for (QString s :  l)
      message(addtostart+s+addtoend);
  }
}

message() [3/3]

void VP1HelperClassBase::message ( const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 91 of file VP1HelperClassBase.cxx.

{
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      message(s);
  } else {
    for (QString s :  l)
      message(s+addtoend);
  }
}

messageDebug() [1/3]

void VP1HelperClassBase::messageDebug ( const QString &  str ) const

inherited

Definition at line 65 of file VP1HelperClassBase.cxx.

{  
  if (!VP1Msg::debug())
    return;
  std::string sysstring(m_system ? " in "+m_system->name().toStdString() : std::string(""));
  if (m_helpername.isEmpty()) {
    std::cout<<VP1Msg::prefix_debug()<<" [helper"<<sysstring<<"]: "<<str.toStdString()<<std::endl;
  } else {
    std::cout<<VP1Msg::prefix_debug()<<" ["<<m_helpername.toStdString()<<sysstring<<"]: "<<str.toStdString()<<std::endl;
  }
}

messageDebug() [2/3]

void VP1HelperClassBase::messageDebug ( const QString &  addtostart, const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 147 of file VP1HelperClassBase.cxx.

{
  if (!VP1Msg::debug())
    return;
  if (addtostart.isEmpty()) {
    messageDebug(l,addtoend);
    return;
  }
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      messageDebug(addtostart+s);
  } else {
    for (QString s :  l)
      messageDebug(addtostart+s+addtoend);
  }
}

messageDebug() [3/3]

void VP1HelperClassBase::messageDebug ( const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 103 of file VP1HelperClassBase.cxx.

{
  if (!VP1Msg::debug())
    return;
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      messageDebug(s);
  } else {
    for (QString s :  l)
      messageDebug(s+addtoend);
  }
}

messageVerbose() [1/3]

void VP1HelperClassBase::messageVerbose ( const QString &  str ) const

inherited

Definition at line 78 of file VP1HelperClassBase.cxx.

{
  if (!VP1Msg::verbose())
    return;
  std::string sysstring(m_system ? " in "+m_system->name().toStdString() : std::string(""));
  if (m_helpername.isEmpty()) {
    std::cout<<VP1Msg::prefix_verbose()<<" [helper"<<sysstring<<"]: "<<str.toStdString()<<std::endl;
  } else {
    std::cout<<VP1Msg::prefix_verbose()<<" ["<<m_helpername.toStdString()<<sysstring<<"]: "<<str.toStdString()<<std::endl;
  }
}

messageVerbose() [2/3]

void VP1HelperClassBase::messageVerbose ( const QString &  addtostart, const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 165 of file VP1HelperClassBase.cxx.

{
  if (!VP1Msg::verbose())
    return;
  if (addtostart.isEmpty()) {
    messageVerbose(l,addtoend);
    return;
  }
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      messageVerbose(addtostart+s);
  } else {
    for (QString s :  l)
      messageVerbose(addtostart+s+addtoend);
  }
}

messageVerbose() [3/3]

void VP1HelperClassBase::messageVerbose ( const QStringList &  l, const QString &  addtoend = ""  ) const

inherited

Definition at line 117 of file VP1HelperClassBase.cxx.

{
  if (!VP1Msg::verbose())
    return;
  if (addtoend.isEmpty()) {
    for (QString s :  l)
      messageVerbose(s);
  } else {
    for (QString s :  l)
      messageVerbose(s+addtoend);
  }
}

setHelperClassName()

void VP1HelperClassBase::setHelperClassName ( const QString &  n )

inlineprotectedinherited

Definition at line 59 of file VP1HelperClassBase.h.

{ m_helpername = n; }

setSystemBasePointer()

void VP1HelperClassBase::setSystemBasePointer ( IVP1System *  sys )

inherited

Definition at line 197 of file VP1HelperClassBase.cxx.

{
  m_system = sys;
  if (VP1Msg::verbose()){
    vp1helperclassbase_instanceMap[this] = (m_system?m_system->name():QString(""));
  }
}

str() [1/30]

static QString VP1String::str ( const Amg::Vector3D &  t )

inlinestaticinherited

Definition at line 98 of file VP1String.h.

{ return "("+str(t.x())+", "+str(t.y())+", "+str(t.z())+")"; }

str() [2/30]

static QString VP1String::str ( const bool  b )

inlinestaticinherited

Definition at line 53 of file VP1String.h.

{ return b?"True":"False"; }

str() [3/30]

static QString VP1String::str ( const char *  c )

inlinestaticinherited

Definition at line 50 of file VP1String.h.

{ return c; }

str() [4/30]

static QString VP1String::str ( const double &  d )

inlinestaticinherited

Definition at line 81 of file VP1String.h.

{ return QString::number(d); }

str() [5/30]

static QString VP1String::str ( const float &  f )

inlinestaticinherited

Definition at line 82 of file VP1String.h.

{ return QString::number(f); }

str() [6/30]

template<class T >

static QString VP1String::str ( const HepGeom::BasicVector3D< T > &  t )

inlinestaticinherited

Definition at line 95 of file VP1String.h.

{ return "("+str(t.x())+", "+str(t.y())+", "+str(t.z())+")"; }

str() [7/30]

QString VP1String::str ( const QColor &  c )

staticinherited

Definition at line 30 of file VP1String.cxx.

{
  return c.isValid() ? c.name() : "Invalid";
}

str() [8/30]

template<class T >

static QString VP1String::str ( const QFlags< T > &  f )

inlinestaticinherited

Definition at line 91 of file VP1String.h.

{ return "0x"+QString::number(f, 16).toUpper().rightJustified(8,'0'); }

str() [9/30]

template<class T >

static QString VP1String::str ( const QList< T > &  t )

inlinestaticinherited

Definition at line 102 of file VP1String.h.

{  return "QList of size"+QString::number(t.size()); }

str() [10/30]

static QString VP1String::str ( const QString &  s )

inlinestaticinherited

Definition at line 49 of file VP1String.h.

{ return s; }

str() [11/30]

QString VP1String::str ( const SbColor &  c )

staticinherited

Definition at line 36 of file VP1String.cxx.

{
  return str(VP1QtInventorUtils::sbcol2qcol(c));
}

str() [12/30]

QString VP1String::str ( const SbVec2d &  v )

staticinherited

Definition at line 61 of file VP1String.cxx.

{ double x,y; v.getValue(x,y); return "("+str(x)+", "+str(y)+")"; }

str() [13/30]

QString VP1String::str ( const SbVec2f &  v )

staticinherited

Definition at line 62 of file VP1String.cxx.

{ float  x,y; v.getValue(x,y); return "("+str(x)+", "+str(y)+")"; }

str() [14/30]

QString VP1String::str ( const SbVec2s &  v )

staticinherited

Definition at line 63 of file VP1String.cxx.

{ short  x,y; v.getValue(x,y); return "("+str(x)+", "+str(y)+")"; }

str() [15/30]

QString VP1String::str ( const SbVec3d &  v )

staticinherited

Definition at line 64 of file VP1String.cxx.

{ double x,y,z; v.getValue(x,y,z); return "("+str(x)+", "+str(y)+", "+str(z)+")"; }

str() [16/30]

QString VP1String::str ( const SbVec3f &  v )

staticinherited

Definition at line 65 of file VP1String.cxx.

{ float  x,y,z; v.getValue(x,y,z); return "("+str(x)+", "+str(y)+", "+str(z)+")"; }

str() [17/30]

QString VP1String::str ( const SbVec3s &  v )

staticinherited

Definition at line 66 of file VP1String.cxx.

{ short  x,y,z; v.getValue(x,y,z); return "("+str(x)+", "+str(y)+", "+str(z)+")"; }

str() [18/30]

QString VP1String::str ( const SbVec4d &  v )

staticinherited

Definition at line 67 of file VP1String.cxx.

{ double x,y,z,t; v.getValue(x,y,z,t); return "("+str(x)+", "+str(y)+", "+str(z)+", "+str(t)+")"; }

str() [19/30]

QString VP1String::str ( const SbVec4f &  v )

staticinherited

Definition at line 68 of file VP1String.cxx.

{ float  x,y,z,t; v.getValue(x,y,z,t); return "("+str(x)+", "+str(y)+", "+str(z)+", "+str(t)+")"; }

str() [20/30]

template<class T >

static QString VP1String::str ( const T *  t )

inlinestaticinherited

Definition at line 87 of file VP1String.h.

{ return str(static_cast<const void* >(t)); }

str() [21/30]

QString VP1String::str ( const void *  p )

staticinherited

Definition at line 48 of file VP1String.cxx.

{
  if (p) {
    std::ostringstream s;
    s << p;
    // Explicitly naming QString here avoids a cppcheck warning.
    return QString (s.str().c_str());
  } else {
    return "NULL";
  }
}

str() [22/30]

QString VP1String::str ( const VP1Interval &  i )

staticinherited

Definition at line 42 of file VP1String.cxx.

{
  return i.toString();
}

str() [23/30]

static QString VP1String::str ( int  n )

inlinestaticinherited

Definition at line 77 of file VP1String.h.

{ return QString::number(n); }

str() [24/30]

static QString VP1String::str ( long  n )

inlinestaticinherited

Definition at line 75 of file VP1String.h.

{ return QString::number(n); }

str() [25/30]

static QString VP1String::str ( qlonglong  n )

inlinestaticinherited

Definition at line 79 of file VP1String.h.

{ return QString::number(n); }

str() [26/30]

static QString VP1String::str ( qulonglong  n )

inlinestaticinherited

Definition at line 80 of file VP1String.h.

{ return QString::number(n); }

str() [27/30]

static QString VP1String::str ( short int  n )

inlinestaticinherited

Definition at line 73 of file VP1String.h.

{ return QString::number(n); }

str() [28/30]

static QString VP1String::str ( uint  n )

inlinestaticinherited

Definition at line 78 of file VP1String.h.

{ return QString::number(n); }

str() [29/30]

static QString VP1String::str ( ulong  n )

inlinestaticinherited

Definition at line 76 of file VP1String.h.

{ return QString::number(n); }

str() [30/30]

static QString VP1String::str ( unsigned short int  n )

inlinestaticinherited

Definition at line 74 of file VP1String.h.

{ return QString::number(n); }

systemBase()

IVP1System* VP1HelperClassBase::systemBase ( ) const

inlineinherited

Definition at line 50 of file VP1HelperClassBase.h.

{ return m_system; }

verbose()

static bool VP1HelperClassBase::verbose ( )

inlinestaticinherited

Definition at line 32 of file VP1HelperClassBase.h.

{ return s_vp1verbose; } // Returns true if env var VP1_VERBOSE_OUTPUT=1

warnUndeletedInstances()

void VP1HelperClassBase::warnUndeletedInstances ( )

staticinherited

Definition at line 183 of file VP1HelperClassBase.cxx.

{
  if (vp1helperclassbase_instanceMap.empty())
    return;
  std::cout << "WARNING: Detected "<<vp1helperclassbase_instanceMap.size()<<" undeleted helper class instances:"<<std::endl;
 
  std::map<VP1HelperClassBase*,QString>::iterator it,itE(vp1helperclassbase_instanceMap.end());
  for (it = vp1helperclassbase_instanceMap.begin();it!=itE;++it) {
    std::cout << "  ==> "<<it->first<<": "<<it->first->m_helpername.toStdString()
          << (it->second.isEmpty()?QString(""):" (in system "+it->second+")").toStdString()<<std::endl;
  }
}

Member Data Documentation

m_helpername

QString VP1HelperClassBase::m_helpername

privateinherited

Definition at line 67 of file VP1HelperClassBase.h.

m_sg

StoreGateSvc* VP1SGContentsHelper::m_sg

private

Definition at line 45 of file VP1SGContentsHelper.h.

m_system

IVP1System* VP1HelperClassBase::m_system

privateinherited

Definition at line 68 of file VP1HelperClassBase.h.

s_vp1verbose

const bool VP1HelperClassBase::s_vp1verbose = VP1QtUtils::environmentVariableIsOn("VP1_VERBOSE_OUTPUT")

staticprivateinherited

Definition at line 69 of file VP1HelperClassBase.h.

---

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

• VP1SGContentsHelper.h
• VP1SGContentsHelper.cxx