BRepGraph_ItemId Class Reference

Generic BRepGraph item identifier covering definitions and references. Use-records are NOT included - they are session-local, not graph identity. More...

#include <BRepGraph_ItemId.hxx>

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

Public Member Functions
	BRepGraph_ItemId ()=default
	Construct an invalid item id.
	BRepGraph_ItemId (const BRepGraph_NodeId theNode)
	Construct a node item id.
	BRepGraph_ItemId (const BRepGraph_RefId theRef)
	Construct a reference item id.
bool	IsValid () const noexcept
	Return true if this item addresses a graph object.
Domain	ItemDomain () const noexcept
	Return the addressed domain.
bool	IsNode () const noexcept
	Return true if this item addresses a definition node.
bool	IsReference () const noexcept
	Return true if this item addresses a reference entry.
BRepGraph_NodeId	NodeId () const noexcept
	Convert to node id. Returns invalid id for non-node items.
BRepGraph_RefId	RefId () const noexcept
	Convert to reference id. Returns invalid id for non-reference items.
BRepGraph_NodeId::Kind	NodeKind () const noexcept
	Return node kind. Valid only when IsNode() is true.
BRepGraph_RefId::Kind	RefKind () const noexcept
	Return reference kind. Valid only when IsReference() is true.
uint8_t	RawKind () const noexcept
	Return item kind encoded in its own domain enum space.
uint8_t	Kind () const noexcept
	Return item kind encoded in its own domain enum space.
uint32_t	Index () const noexcept
	Return item per-kind index.

Detailed Description

Generic BRepGraph item identifier covering definitions and references. Use-records are NOT included - they are session-local, not graph identity.

Member Enumeration Documentation

Domain

enum class BRepGraph_ItemId::Domain : uint8_t

strong

Addressed graph item domain.

Enumerator
None
Node
Reference

Constructor & Destructor Documentation

BRepGraph_ItemId() [1/3]

BRepGraph_ItemId::BRepGraph_ItemId ( )

default

Construct an invalid item id.

BRepGraph_ItemId() [2/3]

BRepGraph_ItemId::BRepGraph_ItemId ( const BRepGraph_NodeId theNode )

inline

Construct a node item id.

BRepGraph_ItemId() [3/3]

BRepGraph_ItemId::BRepGraph_ItemId ( const BRepGraph_RefId theRef )

inline

Construct a reference item id.

Member Function Documentation

Index()

uint32_t BRepGraph_ItemId::Index ( ) const

inlinenoexcept

Return item per-kind index.

IsNode()

bool BRepGraph_ItemId::IsNode ( ) const

inlinenoexcept

Return true if this item addresses a definition node.

IsReference()

bool BRepGraph_ItemId::IsReference ( ) const

inlinenoexcept

Return true if this item addresses a reference entry.

IsValid()

bool BRepGraph_ItemId::IsValid ( ) const

inlinenoexcept

Return true if this item addresses a graph object.

ItemDomain()

Domain BRepGraph_ItemId::ItemDomain ( ) const

inlinenoexcept

Return the addressed domain.

Kind()

uint8_t BRepGraph_ItemId::Kind ( ) const

inlinenoexcept

Return item kind encoded in its own domain enum space.

NodeId()

BRepGraph_NodeId BRepGraph_ItemId::NodeId ( ) const

inlinenoexcept

Convert to node id. Returns invalid id for non-node items.

NodeKind()

BRepGraph_NodeId::Kind BRepGraph_ItemId::NodeKind ( ) const

inlinenoexcept

Return node kind. Valid only when IsNode() is true.

RawKind()

uint8_t BRepGraph_ItemId::RawKind ( ) const

inlinenoexcept

Return item kind encoded in its own domain enum space.

RefId()

BRepGraph_RefId BRepGraph_ItemId::RefId ( ) const

inlinenoexcept

Convert to reference id. Returns invalid id for non-reference items.

RefKind()

BRepGraph_RefId::Kind BRepGraph_ItemId::RefKind ( ) const

inlinenoexcept

Return reference kind. Valid only when IsReference() is true.

---

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

• BRepGraph_ItemId.hxx