BRepGraph_CacheKind Class Reference

Descriptor of one transient cache family. More...

#include <BRepGraph_TransientCache.hxx>

Inheritance diagram for BRepGraph_CacheKind:

Public Member Functions
	BRepGraph_CacheKind (const Standard_GUID &theID, const TCollection_AsciiString &theName=TCollection_AsciiString(), const int theNodeKindsMask=0)
	Create a cache kind descriptor.
const Standard_GUID &	ID () const
	Stable public identity.
const TCollection_AsciiString &	Name () const
	Display-only metadata.
int	NodeKindsMask () const
	Optional node-kind applicability mask.
bool	SupportsNodeKind (const BRepGraph_NodeId::Kind theKind) const
	True if this cache kind is applicable to the given node kind. Cache kinds with NodeKindsMask() == 0 are treated as unrestricted.
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.

Static Public Member Functions
static int	KindBit (const BRepGraph_NodeId::Kind theKind)
	Convenience: bitmask bit for a given node kind.
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.

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

Detailed Description

Descriptor of one transient cache family.

A cache kind defines stable public identity for one class of transient, recomputable per-node data such as bounding boxes or UV bounds. Instances are process-global descriptors registered in BRepGraph_CacheKindRegistry and referenced from graphs by dense runtime slots.

Constructor & Destructor Documentation

BRepGraph_CacheKind()

BRepGraph_CacheKind::BRepGraph_CacheKind	(	const Standard_GUID &	theID,
		const TCollection_AsciiString &	theName = TCollection_AsciiString(),
		const int	theNodeKindsMask = 0 )

Create a cache kind descriptor.

Parameters

[in]	theID	stable public GUID identity
[in]	theName	display-only name
[in]	theNodeKindsMask	optional node-kind applicability mask; 0 means "unspecified / unrestricted"

Member Function Documentation

ID()

const Standard_GUID & BRepGraph_CacheKind::ID ( ) const

inline

Stable public identity.

KindBit()

static int BRepGraph_CacheKind::KindBit ( const BRepGraph_NodeId::Kind theKind )

inlinestatic

Convenience: bitmask bit for a given node kind.

Name()

const TCollection_AsciiString & BRepGraph_CacheKind::Name ( ) const

inline

Display-only metadata.

NodeKindsMask()

int BRepGraph_CacheKind::NodeKindsMask ( ) const

inline

Optional node-kind applicability mask.

SupportsNodeKind()

bool BRepGraph_CacheKind::SupportsNodeKind ( const BRepGraph_NodeId::Kind theKind ) const

inline

True if this cache kind is applicable to the given node kind. Cache kinds with NodeKindsMask() == 0 are treated as unrestricted.

---

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

• BRepGraph_TransientCache.hxx