IParticleHandleBase Class Reference

#include <IParticleHandleBase.h>

Inheritance diagram for IParticleHandleBase:

Collaboration diagram for IParticleHandleBase:

Classes
class	Imp

Public Member Functions
	IParticleHandleBase (IParticleCollHandleBase *)
virtual	~IParticleHandleBase ()
SoMaterial *	determineMaterial ()
	Should be implemented by children, in order to change the material depending on the interface etc. More...
virtual QStringList	baseInfo () const
virtual Amg::Vector3D	momentum () const
virtual const xAOD::IParticle &	iParticle () const =0
virtual double	charge () const =0
virtual double	mass () const
	Returns unknown() in case of trouble. More...
bool	hasCharge () const
bool	hasMass () const
const AODSysCommonData *	common () const
void	setVisible (bool)
	use by the collection handle. More...
bool	visible () const
const AODCollHandleBase *	collHandle () const
virtual bool	has3DObjects ()
	Returns true if the 3D objects have been created. More...
virtual void	update3DObjects ()
	Called after some configuration changes, or when the object is first created. Must be overloaded by children. More...
virtual void	rebuild3DObjects ()
virtual void	clear3DObjects ()=0
	Delete objects. More...
virtual void	attach3DObjects ()
	Connect to the scene graph. More...
virtual void	detach3DObjects ()
	Remove from the scene graph. More...
virtual SoNode *	nodes ()=0
	Returns the 3Dobjects. More...
void	updateMaterial ()
	Called after some configuration related to material changes. More...
SoMaterial *	currentMaterial () const
	Returns the current material of the handle. More...
virtual QStringList	clicked () const =0
	Called when user selects the node (stringlist is displayed in messagebox). More...
virtual QString	shortInfo () const
	returns mom and hit information about track More...
virtual QString	type () const
	return very short word with type (maybe link with collection type?) More...
virtual void	fillObjectBrowser (QList< QTreeWidgetItem * > &list)
	Create and fill the object browser QTreeWidgetItem. More...
void	updateObjectBrowser ()
	Update object browser QTreeWidgetItem. More...
QTreeWidgetItem *	browserTreeItem () const
	Return the QTreeWidgetItem;. More...
virtual void	dumpToJSON (std::ofstream &) const

Static Public Member Functions
static int	numberOfInstances ()
static double	unknown ()

Protected Member Functions
virtual void	visibleStateChanged ()
	Dummy implementation does nothing. More...
virtual void	currentMaterialChanged ()

Private Member Functions
	IParticleHandleBase (const IParticleHandleBase &)
IParticleHandleBase &	operator= (const IParticleHandleBase &)

Private Attributes
Imp *	m_d
bool	m_visible
AODCollHandleBase *	m_collhandle
SoMaterial *	m_currentmaterial

Detailed Description

Definition at line 42 of file IParticleHandleBase.h.

Constructor & Destructor Documentation

IParticleHandleBase() [1/2]

IParticleHandleBase::IParticleHandleBase

(

IParticleCollHandleBase *

ch

)

Definition at line 59 of file IParticleHandleBase.cxx.

  : AODHandleBase(ch), m_d(new Imp(this))
{
}

~IParticleHandleBase()

IParticleHandleBase::~IParticleHandleBase ( )

virtual

Definition at line 65 of file IParticleHandleBase.cxx.

{
  delete m_d;
}

IParticleHandleBase() [2/2]

IParticleHandleBase::IParticleHandleBase ( const IParticleHandleBase &  )

private

Member Function Documentation

attach3DObjects()

void AODHandleBase::attach3DObjects ( )

virtualinherited

Connect to the scene graph.

Definition at line 157 of file AODHandleBase.cxx.

{
  VP1Msg::messageVerbose("AODHandleBase::attach3DObjects");
 
  if (!m_currentmaterial) {
    m_currentmaterial = determineMaterial();
    m_currentmaterial->ref();
    currentMaterialChanged();
  }
  if (has3DObjects() && m_collhandle->sepHelper()) {
    VP1Msg::messageVerbose("Adding nodes to sep helper...");
  
    m_collhandle->common()->registerHandle(this);
 
    // debug
    // std::cout<<"m_collhandle->sepHelper() = " << m_collhandle->sepHelper()<<std::endl;
    SoNode* tmp = nodes();
    // std::cout << "tmp nodes = "<< tmp << std::endl;
 
    //      m_collhandle->sepHelper()->addNodeUnderMaterial( nodes(), m_currentmaterial );
    m_collhandle->sepHelper()->addNodeUnderMaterial( tmp, m_currentmaterial );
 
  } else {
    if (!has3DObjects()) {
      VP1Msg::message("AODHandleBase::attach3DObjects() - No 3D objects to attach!");
    }
    if (!m_collhandle->sepHelper()) VP1Msg::message("AODHandleBase::attach3DObjects() - No sep helper!");
  }
  // if (label_sep && theclass->common()->textSep() && theclass->common()->controller()->doTrackLabels())
  //   theclass->common()->textSep()->addChild(label_sep);
  //
}

baseInfo()

QStringList IParticleHandleBase::baseInfo ( ) const

virtual

Reimplemented from AODHandleBase.

Definition at line 85 of file IParticleHandleBase.cxx.

{
  QStringList l;
  Amg::Vector3D mom = momentum()/1000;
  if (mom.mag2()==0.0) {
    l << "Momentum : 0 (undefined)";
  } else {
    l << "Momentum [GeV]: "+VP1Msg::str(mom);
    l << "|Pt|/|P| [GeV]: "+VP1Msg::str(mom.perp())+" / " + VP1Msg::str(mom.mag());
    l << VP1Msg::str("(")+QChar(0x03B7)+","+QChar(0x03D5)+VP1Msg::str(")=(")
      +VP1Msg::str(mom.eta())+VP1Msg::str(",")+VP1Msg::str(VP1LinAlgUtils::phiFromXY(mom.x(), mom.y() ))+VP1Msg::str(")");
    
    l << "Eta: "+VP1Msg::str(mom.eta());
    l << "Phi: "+VP1Msg::str(VP1LinAlgUtils::phiFromXY(mom.x(), mom.y() ));
  }
  // l<<"Hit summary: Pix["+VP1Msg::str(getNPixelHits())+"], SCT["+VP1Msg::str(getNSCTHits())+"], TRT["+VP1Msg::str(getNTRTHits())
  //   +"], MDT["+QString::number(getNMDTHits())+"], RPC["+QString::number(getNRPCHits())+"], TGC["+QString::number(getNTGCHits())+"], CSC["+QString::number(getNCSCHits())+"].";
  // 
  // return l;
  // int pdg = pdgCode();
  // if (pdg) {
  //   bool ok;
  //   QString name = VP1ParticleData::particleName(pdg,ok);
  //   if (ok)
  //     l << "pdg: "+QString::number(pdg)+" ["+name+"]";
  //   else
  //     l << "pdg: "+QString::number(pdg);
  // }
 
  return l;
}

browserTreeItem()

QTreeWidgetItem * AODHandleBase::browserTreeItem ( ) const

inherited

Return the QTreeWidgetItem;.

Definition at line 311 of file AODHandleBase.cxx.

                                                      {
  return m_d->m_objBrowseTree;
}

charge()

virtual double IParticleHandleBase::charge ( ) const

pure virtual

Implemented in IParticleHandle_CaloCluster, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, and IParticleHandle_Muon.

clear3DObjects()

virtual void AODHandleBase::clear3DObjects ( )

pure virtualinherited

Delete objects.

Implemented in VertexHandle, IParticleHandle_CaloCluster, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, MissingEtHandle, and IParticleHandle_Muon.

clicked()

virtual QStringList AODHandleBase::clicked ( ) const

pure virtualinherited

Called when user selects the node (stringlist is displayed in messagebox).

Reimplementations should add info momInfo() to get momentum, eta, phi, pid,charge, mass printed.

Implemented in IParticleHandle_CaloCluster, VertexHandle, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, MissingEtHandle, and IParticleHandle_Muon.

collHandle()

const AODCollHandleBase* AODHandleBase::collHandle ( ) const

inlineinherited

Definition at line 55 of file AODHandleBase.h.

{ return m_collhandle; }

common()

const AODSysCommonData * AODHandleBase::common ( ) const

inherited

Definition at line 93 of file AODHandleBase.cxx.

{
  return std::as_const(m_collhandle)->common();
}

currentMaterial()

SoMaterial* AODHandleBase::currentMaterial ( ) const

inlineinherited

Returns the current material of the handle.

Definition at line 76 of file AODHandleBase.h.

{ return m_currentmaterial; }

currentMaterialChanged()

virtual void AODHandleBase::currentMaterialChanged ( )

inlineprotectedvirtualinherited

Definition at line 111 of file AODHandleBase.h.

{};

detach3DObjects()

void AODHandleBase::detach3DObjects ( )

virtualinherited

Remove from the scene graph.

Definition at line 191 of file AODHandleBase.cxx.

{
  VP1Msg::messageVerbose("AODHandleBase::detach3DObjects");
    
  if (!m_currentmaterial)
    return;//Can never have been attached!
  if (has3DObjects() && m_collhandle->sepHelper()) {
    m_collhandle->sepHelper()->removeNodeUnderMaterial(nodes(),m_currentmaterial);
  }
  
  m_collhandle->common()->deregisterHandle(this);
  
  // if (label_sep && theclass->common()->textSep()) 
  //   theclass->common()->textSep()->removeChild(label_sep);
}

determineMaterial()

SoMaterial * IParticleHandleBase::determineMaterial ( )

virtual

Should be implemented by children, in order to change the material depending on the interface etc.

This will (by default) return the collection material.

Implements AODHandleBase.

Definition at line 71 of file IParticleHandleBase.cxx.

                                                    {
  // By default we use the collection material.
  // std::cout<<"AODHandleBase::determineMaterial() - collHandle()->material()"<<collHandle()->material()<<std::endl;
  return collHandle()->material();
}

dumpToJSON()

virtual void AODHandleBase::dumpToJSON ( std::ofstream &  ) const

inlinevirtualinherited

Reimplemented in IParticleHandle_CaloCluster, IParticleHandle_Electron, IParticleHandle_Jet, and IParticleHandle_TrackParticle.

Definition at line 106 of file AODHandleBase.h.

{}; 

fillObjectBrowser()

void AODHandleBase::fillObjectBrowser ( QList< QTreeWidgetItem * > &  list )

virtualinherited

Create and fill the object browser QTreeWidgetItem.

Reimplemented in IParticleHandle_Electron, IParticleHandle_TrackParticle, MissingEtHandle, IParticleHandle_Muon, IParticleHandle_CaloCluster, and IParticleHandle_Jet.

Definition at line 288 of file AODHandleBase.cxx.

                                                                            {
 
  VP1Msg::messageDebug("AODHandleBase::fillObjectBrowser()");
 
  if (m_d->m_objBrowseTree){
    VP1Msg::message("ERROR: AODHandleBase::fillObjectBrowser - already have m_objBrowseTree. Aborting.");
    return;
  }
    
  m_d->m_objBrowseTree = new QTreeWidgetItem();
 
  QString l = shortInfo();
 
  m_d->m_objBrowseTree->setText(0, type()+QString(QString::number(listOfItems.size())) );
  m_d->m_objBrowseTree->setText(1, l );    
 
  if (!visible()) {
    m_d->m_objBrowseTree->setFlags(Qt::ItemFlags()); // not selectable, not enabled
  }
  listOfItems << browserTreeItem();
}

has3DObjects()

virtual bool AODHandleBase::has3DObjects ( )

inlinevirtualinherited

Returns true if the 3D objects have been created.

Reimplemented in IParticleHandle_CaloCluster, VertexHandle, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, MissingEtHandle, and IParticleHandle_Muon.

Definition at line 57 of file AODHandleBase.h.

{return false;}

hasCharge()

bool IParticleHandleBase::hasCharge ( ) const

inline

Definition at line 59 of file IParticleHandleBase.h.

{ return charge()!=unknown(); }

hasMass()

bool IParticleHandleBase::hasMass ( ) const

inline

Definition at line 60 of file IParticleHandleBase.h.

{ return mass()!=unknown(); }

iParticle()

virtual const xAOD::IParticle& IParticleHandleBase::iParticle ( ) const

pure virtual

Implemented in IParticleHandle_CaloCluster, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, and IParticleHandle_Muon.

mass()

double IParticleHandleBase::mass ( ) const

virtual

Returns unknown() in case of trouble.

Definition at line 78 of file IParticleHandleBase.cxx.

{
  return 0.0;
}

momentum()

virtual Amg::Vector3D IParticleHandleBase::momentum ( ) const

inlinevirtual

Reimplemented in IParticleHandle_Electron, IParticleHandle_TrackParticle, and IParticleHandle_Muon.

Definition at line 52 of file IParticleHandleBase.h.

{ return Amg::Vector3D(0,0,0); }

nodes()

virtual SoNode* AODHandleBase::nodes ( )

pure virtualinherited

Returns the 3Dobjects.

Implemented in VertexHandle, IParticleHandle_CaloCluster, IParticleHandle_Jet, IParticleHandle_Electron, IParticleHandle_TrackParticle, MissingEtHandle, and IParticleHandle_Muon.

numberOfInstances()

int AODHandleBase::numberOfInstances ( )

staticinherited

Definition at line 87 of file AODHandleBase.cxx.

{
  return Imp::nobjhandles;
}

operator=()

IParticleHandleBase& IParticleHandleBase::operator= ( const IParticleHandleBase &  )

private

rebuild3DObjects()

void AODHandleBase::rebuild3DObjects ( )

virtualinherited

Definition at line 137 of file AODHandleBase.cxx.

{  
  QString tmp2 = (m_visible==true)?"True":"False";
  VP1Msg::messageDebug("AODHandleBase::rebuild3DObjects() - with m_visible="+tmp2 );
  
  //Ensure we are always detached while updating.
  if (m_visible) {
    detach3DObjects();
  }
 
  clear3DObjects();
  nodes(); // rebuilds the 3D shapes
 
  //Attach if visible:
  if (m_visible) {
    attach3DObjects();
  }
}

setVisible()

void AODHandleBase::setVisible ( bool  vis )

inherited

use by the collection handle.

Definition at line 99 of file AODHandleBase.cxx.

{
  QString tmp = (vis==true)?"True":"False";
  QString tmp2 = (m_visible==true)?"True":"False";
  VP1Msg::messageDebug(QString("AODHandleBase calling setVisible with vis=")+tmp+QString(", and m_visible=")+tmp2 );
  if (vis==m_visible)
    return;
 
  m_visible=vis;
  if (vis) {
    m_collhandle->incrementNShownHandles();
 
    if (!has3DObjects())
      rebuild3DObjects();//The call to rebuild also fixes attached state.
    else
      attach3DObjects();
  } else {
    m_collhandle->decrementNShownHandles();
    detach3DObjects();
  }
 
  visibleStateChanged();
}

shortInfo()

virtual QString AODHandleBase::shortInfo ( ) const

inlinevirtualinherited

returns mom and hit information about track

Reimplemented in IParticleHandle_CaloCluster, IParticleHandle_Electron, IParticleHandle_Jet, IParticleHandle_TrackParticle, VertexHandle, MissingEtHandle, and IParticleHandle_Muon.

Definition at line 95 of file AODHandleBase.h.

type()

virtual QString AODHandleBase::type ( ) const

inlinevirtualinherited

return very short word with type (maybe link with collection type?)

Reimplemented in IParticleHandle_CaloCluster, VertexHandle, IParticleHandle_Electron, IParticleHandle_Jet, IParticleHandle_TrackParticle, MissingEtHandle, and IParticleHandle_Muon.

Definition at line 96 of file AODHandleBase.h.

unknown()

static double AODHandleBase::unknown ( )

inlinestaticinherited

Definition at line 93 of file AODHandleBase.h.

{ return -999.0; }

update3DObjects()

void AODHandleBase::update3DObjects ( )

virtualinherited

Called after some configuration changes, or when the object is first created. Must be overloaded by children.

Definition at line 125 of file AODHandleBase.cxx.

{
  if (m_visible) {
    rebuild3DObjects();
  } else {    
    //Simply clear the present 3D objects. They will only be recreated if/when the track/jet becomes visible again.
    clear3DObjects();
  }
}

updateMaterial()

void AODHandleBase::updateMaterial ( )

inherited

Called after some configuration related to material changes.

Definition at line 208 of file AODHandleBase.cxx.

{
  VP1Msg::messageVerbose("AODHandleBase::updateMaterial()");
    
  //We need to change the current material. This means we need to
  //clear the cache. Only if we are visible do we need to do a
  //detach->clear material->attach cycle to trigger attachment under new material.
 
  if (!m_currentmaterial)
    return;//We have no material cached and is thus not attached either.
  if (m_visible) {
    //See if the material changed. If it did, detach, update the material, attach again.
    SoMaterial * newmat = determineMaterial();
    newmat->ref();
    if (newmat!=m_currentmaterial) {
      detach3DObjects();
      m_currentmaterial->unref();
      m_currentmaterial = newmat;
      attach3DObjects();
      currentMaterialChanged();
    } else {
      newmat->unref();
    }
  } else {
    //Just clear material.
    m_currentmaterial->unref();
    m_currentmaterial = 0;
    currentMaterialChanged();
  }
}

updateObjectBrowser()

void AODHandleBase::updateObjectBrowser ( )

inlineinherited

Update object browser QTreeWidgetItem.

Definition at line 102 of file AODHandleBase.h.

{};

visible()

bool AODHandleBase::visible ( ) const

inlineinherited

Definition at line 54 of file AODHandleBase.h.

{ return m_visible; }

visibleStateChanged()

void AODHandleBase::visibleStateChanged ( )

protectedvirtualinherited

Dummy implementation does nothing.

override if need to take action in this case.

Definition at line 316 of file AODHandleBase.cxx.

{  
  if ( !browserTreeItem()) {
    VP1Msg::messageVerbose("visibleStateChanged: No m_objBrowseTree!");
    return;
  }
    
  if (!visible()) {
    browserTreeItem()->setFlags(Qt::ItemFlags()); // not selectable, not enabled
  } else {
    browserTreeItem()->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled); //  selectable,  enabled
  }  
  QFont itemFont = browserTreeItem()->font(0);
  itemFont.setStrikeOut(!visible());
  browserTreeItem()->setFont(0, itemFont);
  browserTreeItem()->setFont(1, itemFont);
}

Member Data Documentation

m_collhandle

AODCollHandleBase* AODHandleBase::m_collhandle

privateinherited

Definition at line 126 of file AODHandleBase.h.

m_currentmaterial

SoMaterial* AODHandleBase::m_currentmaterial

privateinherited

Definition at line 127 of file AODHandleBase.h.

m_d

Imp* IParticleHandleBase::m_d

private

Definition at line 71 of file IParticleHandleBase.h.

m_visible

bool AODHandleBase::m_visible

privateinherited

Definition at line 125 of file AODHandleBase.h.

---

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

• IParticleHandleBase.h
• IParticleHandleBase.cxx