LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
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 ()
 
PyObjectPtroperator= (PyObjectPtr const &other)
 
PyObjectPtroperator= (PyObjectPtr &&other)
 
PyObjectPtroperator= (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.

51: m_object(object) {}

◆ PyObjectPtr() [2/3]

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

Definition at line 54 of file PyObjectPtr.h.

54 : m_object(other.m_object) {
55 Py_XINCREF(m_object);
56 }

◆ PyObjectPtr() [3/3]

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

Definition at line 59 of file PyObjectPtr.h.

59 : m_object(other.m_object) {
60 other.m_object = nullptr;
61 }

◆ ~PyObjectPtr()

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

Definition at line 64 of file PyObjectPtr.h.

64{ 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.

43 {
44 Py_XINCREF(object);
45 return PyObjectPtr(object);
46 }
PyObjectPtr(PyObject *object=nullptr)
Construct a pointer from a regular "new" object reference.
Definition PyObjectPtr.h:51

◆ get()

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

Definition at line 99 of file PyObjectPtr.h.

99{ return m_object; }

◆ operator PyObject *()

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

Definition at line 88 of file PyObjectPtr.h.

88{ return m_object; }

◆ operator!=()

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

Definition at line 103 of file PyObjectPtr.h.

103{ return m_object != nullptr; }

◆ operator=() [1/3]

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

Definition at line 80 of file PyObjectPtr.h.

80 {
81 Py_CLEAR(m_object);
82 m_object = object;
83 Py_XINCREF(m_object);
84 return *this;
85 }
table::Key< std::string > object
Definition VisitInfo.cc:232

◆ operator=() [2/3]

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

Definition at line 73 of file PyObjectPtr.h.

73 {
74 Py_CLEAR(m_object);
75 m_object = other.m_object;
76 other.m_object = nullptr;
77 return *this;
78 }

◆ operator=() [3/3]

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

Definition at line 66 of file PyObjectPtr.h.

66 {
67 Py_CLEAR(m_object);
68 m_object = other.m_object;
69 Py_XINCREF(m_object);
70 return *this;
71 }

◆ operator==()

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

Definition at line 102 of file PyObjectPtr.h.

102{ return m_object == nullptr; }

◆ release()

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

Definition at line 91 of file PyObjectPtr.h.

91 {
92 auto object = m_object;
93 m_object = nullptr;
94 return object;
95 }

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