Abstract base for transient per-node cache values. More...

#include <BRepGraph_TransientCache.hxx>

Inheritance diagram for BRepGraph_CacheValue:

[legend]

Public Member Functions
void	Invalidate ()
	Mark the cached value as needing recomputation. Lock-free.

bool	IsDirty () const
	True if the cached value needs recomputation.

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.

Protected Member Functions
	BRepGraph_CacheValue ()

void	MarkClean () const
	Subclass calls after successful computation to clear the dirty flag.

Protected Attributes
std::shared_mutex	myMutex
	Mutex for thread-safe Get() in subclasses.

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

Abstract base for transient per-node cache values.

Inherits from Standard_Transient and is stored via occ::handle<BRepGraph_CacheValue>. This uses OCCT's embedded refcount and is consistent with the Handle pattern used throughout the codebase.

Constructor & Destructor Documentation

◆ BRepGraph_CacheValue()

BRepGraph_CacheValue::BRepGraph_CacheValue ( )

inlineprotected

Member Function Documentation

◆ Invalidate()

void BRepGraph_CacheValue::Invalidate ( )

inline

Mark the cached value as needing recomputation. Lock-free.

◆ IsDirty()

bool BRepGraph_CacheValue::IsDirty ( ) const

inline

True if the cached value needs recomputation.

◆ MarkClean()

void BRepGraph_CacheValue::MarkClean ( ) const

inlineprotected

Subclass calls after successful computation to clear the dirty flag.

Field Documentation

◆ myMutex

std::shared_mutex BRepGraph_CacheValue::myMutex

mutableprotected

Mutex for thread-safe Get() in subclasses.

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

BRepGraph_TransientCache.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members