lsst::log::detail::PyObjectPtr Class Reference

Smart pointer class for PyObject instances. More...

#include <PyObjectPtr.h>

Public Member Functions
	PyObjectPtr (PyObject *object=nullptr)
	Construct a pointer from a regular "new" object reference.
	PyObjectPtr (PyObjectPtr const &other)
	PyObjectPtr (PyObjectPtr &&other)
	~PyObjectPtr ()
PyObjectPtr &	operator= (PyObjectPtr const &other)
PyObjectPtr &	operator= (PyObjectPtr &&other)
PyObjectPtr &	operator= (PyObject *object)
	operator PyObject * () const
PyObject *	release ()
PyObject *&	get ()
bool	operator== (std::nullptr_t) const
bool	operator!= (std::nullptr_t) const

Static Public Member Functions
static PyObjectPtr	from_borrowed (PyObject *object)
	Wraps a "borrowed" object reference, reference counter is incremented.

Detailed Description

Smart pointer class for PyObject instances.

Definition at line 37 of file PyObjectPtr.h.

Constructor & Destructor Documentation

PyObjectPtr() [1/3]

lsst::log::detail::PyObjectPtr::PyObjectPtr ( PyObject * object = nullptr )

inlineexplicit

Construct a pointer from a regular "new" object reference.

Definition at line 51 of file PyObjectPtr.h.

: m_object(object) {}

PyObjectPtr() [2/3]

lsst::log::detail::PyObjectPtr::PyObjectPtr ( PyObjectPtr const & other )

inline

Definition at line 54 of file PyObjectPtr.h.

                                          : m_object(other.m_object) {
        Py_XINCREF(m_object);
    }

PyObjectPtr() [3/3]

lsst::log::detail::PyObjectPtr::PyObjectPtr ( PyObjectPtr && other )

inline

Definition at line 59 of file PyObjectPtr.h.

                                     : m_object(other.m_object) {
        other.m_object = nullptr;
    }

~PyObjectPtr()

lsst::log::detail::PyObjectPtr::~PyObjectPtr ( )

inline

Definition at line 64 of file PyObjectPtr.h.

{ Py_CLEAR(m_object); }

Member Function Documentation

from_borrowed()

static PyObjectPtr lsst::log::detail::PyObjectPtr::from_borrowed ( PyObject * object )

inlinestatic

Wraps a "borrowed" object reference, reference counter is incremented.

Definition at line 43 of file PyObjectPtr.h.

                                                       {
        Py_XINCREF(object);
        return PyObjectPtr(object);
    }

get()

PyObject *& lsst::log::detail::PyObjectPtr::get ( )

inline

Definition at line 99 of file PyObjectPtr.h.

{ return m_object; }

operator PyObject *()

lsst::log::detail::PyObjectPtr::operator PyObject * ( ) const

inline

Definition at line 88 of file PyObjectPtr.h.

{ return m_object; }

operator!=()

bool lsst::log::detail::PyObjectPtr::operator!= ( std::nullptr_t ) const

inline

Definition at line 103 of file PyObjectPtr.h.

{ return m_object != nullptr; }

operator=() [1/3]

PyObjectPtr & lsst::log::detail::PyObjectPtr::operator= ( PyObject * object )

inline

Definition at line 80 of file PyObjectPtr.h.

                                             {
        Py_CLEAR(m_object);
        m_object = object;
        Py_XINCREF(m_object);
        return *this;
    }

operator=() [2/3]

PyObjectPtr & lsst::log::detail::PyObjectPtr::operator= ( PyObjectPtr && other )

inline

Definition at line 73 of file PyObjectPtr.h.

                                                {
        Py_CLEAR(m_object);
        m_object = other.m_object;
        other.m_object = nullptr;
        return *this;
    }

operator=() [3/3]

PyObjectPtr & lsst::log::detail::PyObjectPtr::operator= ( PyObjectPtr const & other )

inline

Definition at line 66 of file PyObjectPtr.h.

                                                     {
        Py_CLEAR(m_object);
        m_object = other.m_object;
        Py_XINCREF(m_object);
        return *this;
    }

operator==()

bool lsst::log::detail::PyObjectPtr::operator== ( std::nullptr_t ) const

inline

Definition at line 102 of file PyObjectPtr.h.

{ return m_object == nullptr; }

release()

PyObject * lsst::log::detail::PyObjectPtr::release ( )

inline

Definition at line 91 of file PyObjectPtr.h.

                        {
        auto object = m_object;
        m_object = nullptr;
        return object;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/log/gf0baf85859+c1f95f4921/python/lsst/log/log/PyObjectPtr.h