Public Member Functions | Protected Member Functions | Private Attributes | List of all members
Object Class Referenceabstract

Reference counted object base class. More...

#include <object.h>

Public Member Functions

void decRef (bool dealloc=true) const
 Decrease the reference count of the object and possibly deallocate it. More...
 
int getRefCount () const
 Return the current reference count. More...
 
void incRef () const
 Increase the object's reference count by one. More...
 
 Object ()
 Default constructor. More...
 
 Object (const Object &)
 Copy constructor. More...
 
virtual std::string toString () const =0
 

Protected Member Functions

virtual ~Object ()
 Virtual protected deconstructor. (Will only be called by ref) More...
 

Private Attributes

std::atomic< intm_refCount {0}
 

Detailed Description

Reference counted object base class.

Definition at line 9 of file object.h.

Constructor & Destructor Documentation

◆ Object() [1/2]

Object::Object ( )
inline

Default constructor.

Definition at line 12 of file object.h.

◆ Object() [2/2]

Object::Object ( const Object )
inline

Copy constructor.

Definition at line 15 of file object.h.

◆ ~Object()

virtual Object::~Object ( )
inlineprotectedvirtual

Virtual protected deconstructor. (Will only be called by ref)

Definition at line 44 of file object.h.

Member Function Documentation

◆ decRef()

void Object::decRef ( bool  dealloc = true) const
inline

Decrease the reference count of the object and possibly deallocate it.

The object will automatically be deallocated once the reference count reaches zero.

Definition at line 29 of file object.h.

◆ getRefCount()

int Object::getRefCount ( ) const
inline

Return the current reference count.

Definition at line 18 of file object.h.

◆ incRef()

void Object::incRef ( ) const
inline

Increase the object's reference count by one.

Definition at line 21 of file object.h.

◆ toString()

virtual std::string Object::toString ( ) const
pure virtual

Member Data Documentation

◆ m_refCount

std::atomic<int> Object::m_refCount {0}
mutableprivate

Definition at line 47 of file object.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:43:36