RootUtils::TreeNotifier Class Reference

Tree notification handler. More...

Inheritance diagram for RootUtils::TreeNotifier:

Collaboration diagram for RootUtils::TreeNotifier:

Public Member Functions
	TreeNotifier (TTree *tree, PyObject *treeobj_ref)
	Constructor. More...
virtual	~TreeNotifier ()
	Destructor. More...
virtual Bool_t	Notify () override
	Root notification hook. More...
virtual void	Clear (Option_t *="") override
	Called when the tree we're attached to is deleted. More...

Private Attributes
PyObject *	m_treeobj_ref
	A weak reference to the Python object for the tree. More...
TObject *	m_chain
	Notification tree. More...
TTree *	m_tree
	The tree to which we're attached. More...

Detailed Description

Tree notification handler.

This is the tree notification handler. When it's Notify method is called, we need to do two things. First, clear the cached branches/leaves. Second, call any Python notification handler.

Definition at line 67 of file PyROOTTTreePatch.cxx.

Constructor & Destructor Documentation

TreeNotifier()

RootUtils::TreeNotifier::TreeNotifier	(	TTree *	tree,
		PyObject *	treeobj_ref
	)

Constructor.

Parameters

tree	The tree for which we're creating the notification.
treeobj_ref	A weak reference to the tree for which we're creating the notification. We take ownership of the reference object.

Definition at line 110 of file PyROOTTTreePatch.cxx.

  : m_treeobj_ref (treeobj_ref),
    m_chain (tree->GetNotify()),
    m_tree (tree)
{
  // We acquire ownership of treeobj_ref.
}

~TreeNotifier()

RootUtils::TreeNotifier::~TreeNotifier ( )

virtual

Destructor.

Definition at line 123 of file PyROOTTTreePatch.cxx.

{
  RootUtils::PyGILStateEnsure gil;
  if (m_tree) {
    // Clear the reference from the tree to this object.
    m_tree->SetNotify (m_chain);
  }
  Py_XDECREF (m_treeobj_ref);
}

Member Function Documentation

Clear()

void RootUtils::TreeNotifier::Clear ( Option_t *  = "" )

overridevirtual

Called when the tree we're attached to is deleted.

Definition at line 180 of file PyROOTTTreePatch.cxx.

{
  m_tree = nullptr;
}

Notify()

Bool_t RootUtils::TreeNotifier::Notify ( )

overridevirtual

Root notification hook.

Definition at line 137 of file PyROOTTTreePatch.cxx.

{
  RootUtils::PyGILStateEnsure gil;
 
  // Intern __pynotify__ if needed.
  if (pynotify_str == 0)
    pynotify_str = PyUnicode_InternFromString("__pynotify__");
 
  // Look for a notification object.
#if PY_VERSION_HEX >=  0x030d0000
  PyObject* treeobj = nullptr;
  (void)PyWeakref_GetRef (m_treeobj_ref, &treeobj);
#else
  PyObject* treeobj = PyWeakref_GetObject (m_treeobj_ref);
#endif
  if (treeobj) {
    PyObject** dictptr = _PyObject_GetDictPtr (treeobj);
    if (dictptr && *dictptr) {
      PyObject* notobj = PyObject_GetItem (*dictptr, pynotify_str);
#if PY_VERSION_HEX >=  0x030d0000
      Py_DECREF(treeobj);
#endif
      if (notobj) {
        // Got it --- call @c Notify.
        PyObject* ret =
          PyObject_CallMethod (notobj, const_cast<char*> ("Notify"), NULL);
#if PY_VERSION_HEX >=  0x030d0000
        Py_DECREF (notobj);
#endif
        if (!ret) return 0;
        Py_DECREF (ret);
      }
      else
        PyErr_Clear();
    }
  }
 
  if (m_chain) m_chain->Notify();
  return true;
}

Member Data Documentation

m_chain

TObject* RootUtils::TreeNotifier::m_chain

private

Notification tree.

Definition at line 96 of file PyROOTTTreePatch.cxx.

m_tree

TTree* RootUtils::TreeNotifier::m_tree

private

The tree to which we're attached.

Definition at line 99 of file PyROOTTTreePatch.cxx.

m_treeobj_ref

PyObject* RootUtils::TreeNotifier::m_treeobj_ref

private

A weak reference to the Python object for the tree.

Making it a reference prevents a reference cycle.

Definition at line 93 of file PyROOTTTreePatch.cxx.

---

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

• PyROOTTTreePatch.cxx