BRepGraph_ItemUID Class Reference

Durable BRepGraph item identity covering definition nodes and reference entries. More...

#include <BRepGraph_ItemUID.hxx>

Public Types
enum class	Domain : uint8_t { None , Node , Reference }
	Addressed persistent identity domain. More...

Public Member Functions
	BRepGraph_ItemUID ()=default
	Construct an invalid UID.
bool	IsValid () const noexcept
	Return true if this UID has a non-sentinel counter and a valid domain/kind pair.
Domain	ItemDomain () const noexcept
	Return the addressed identity domain.
bool	IsNode () const noexcept
bool	IsReference () const noexcept
BRepGraph_NodeId::Kind	NodeKind () const noexcept
	Return node kind. Valid only for node UIDs.
BRepGraph_RefId::Kind	RefKind () const noexcept
	Return reference kind. Valid only for reference UIDs.
uint8_t	RawKind () const noexcept
	Return item kind encoded in its own domain enum space.
size_t	Counter () const noexcept
	Return the graph-wide monotonic UID counter.
size_t	HashValue () const noexcept
	Compute a hash value compatible with operator==.

Static Public Member Functions
static BRepGraph_ItemUID	Node (const BRepGraph_NodeId::Kind theKind, const size_t theCounter)
	Construct a node UID.
static BRepGraph_ItemUID	Reference (const BRepGraph_RefId::Kind theKind, const size_t theCounter)
	Construct a reference UID.
static BRepGraph_ItemUID	Invalid ()
	Return an invalid sentinel UID.

Detailed Description

Durable BRepGraph item identity covering definition nodes and reference entries.

BRepGraph_ItemId is a transient structural address. BRepGraph_ItemUID is the persistent identity assigned at item creation and kept stable across compaction and vector reordering. Representation/use records are not addressed here because they do not have persisted identity.

Member Enumeration Documentation

Domain

enum class BRepGraph_ItemUID::Domain : uint8_t

strong

Addressed persistent identity domain.

Enumerator
None
Node
Reference

Constructor & Destructor Documentation

BRepGraph_ItemUID()

BRepGraph_ItemUID::BRepGraph_ItemUID ( )

default

Construct an invalid UID.

Member Function Documentation

Counter()

size_t BRepGraph_ItemUID::Counter ( ) const

inlinenoexcept

Return the graph-wide monotonic UID counter.

HashValue()

size_t BRepGraph_ItemUID::HashValue ( ) const

inlinenoexcept

Compute a hash value compatible with operator==.

Invalid()

static BRepGraph_ItemUID BRepGraph_ItemUID::Invalid ( )

inlinestatic

Return an invalid sentinel UID.

IsNode()

bool BRepGraph_ItemUID::IsNode ( ) const

inlinenoexcept

IsReference()

bool BRepGraph_ItemUID::IsReference ( ) const

inlinenoexcept

IsValid()

bool BRepGraph_ItemUID::IsValid ( ) const

inlinenoexcept

Return true if this UID has a non-sentinel counter and a valid domain/kind pair.

ItemDomain()

Domain BRepGraph_ItemUID::ItemDomain ( ) const

inlinenoexcept

Return the addressed identity domain.

Node()

static BRepGraph_ItemUID BRepGraph_ItemUID::Node ( const BRepGraph_NodeId::Kind theKind, const size_t theCounter )

inlinestatic

Construct a node UID.

NodeKind()

BRepGraph_NodeId::Kind BRepGraph_ItemUID::NodeKind ( ) const

inlinenoexcept

Return node kind. Valid only for node UIDs.

RawKind()

uint8_t BRepGraph_ItemUID::RawKind ( ) const

inlinenoexcept

Return item kind encoded in its own domain enum space.

Reference()

static BRepGraph_ItemUID BRepGraph_ItemUID::Reference ( const BRepGraph_RefId::Kind theKind, const size_t theCounter )

inlinestatic

Construct a reference UID.

RefKind()

BRepGraph_RefId::Kind BRepGraph_ItemUID::RefKind ( ) const

inlinenoexcept

Return reference kind. Valid only for reference UIDs.

---

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

• BRepGraph_ItemUID.hxx