Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI. More...

#include <NCollection_Shared.hxx>

Inheritance diagram for NCollection_Shared< T, typename >:

[legend]

Public Member Functions
	NCollection_Shared ()=default
	Default constructor.

template<typename T1 >
	NCollection_Shared (const T1 &arg1)
	Constructor with single argument.

template<typename T1 >
	NCollection_Shared (T1 &arg1)
	Constructor with single argument.

template<typename T1 , typename T2 >
	NCollection_Shared (const T1 &arg1, const T2 &arg2)
	Constructor with two arguments.

template<typename T1 , typename T2 >
	NCollection_Shared (T1 &arg1, const T2 &arg2)
	Constructor with two arguments.

template<typename T1 , typename T2 >
	NCollection_Shared (const T1 &arg1, T2 &arg2)
	Constructor with two arguments.

template<typename T1 , typename T2 >
	NCollection_Shared (T1 &arg1, T2 &arg2)
	Constructor with two arguments.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

template<class T, typename = typename opencascade::std::enable_if< !opencascade::std::is_base_of<Standard_Transient, T>::value>::type>
class NCollection_Shared< T, typename >

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.

This provides possibility to use Handes for types not initially intended to be dynamically allocated.

Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.

The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.