OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    BRepGraph_UID Struct Reference

    Unique definition-node identifier within a BRepGraph. More...

    #include <BRepGraph_UID.hxx>

    Public Member Functions

     BRepGraph_UID ()=default
     Default: invalid UID (counter = 0 is the invalid sentinel).
     BRepGraph_UID (const BRepGraph_NodeId::Kind theKind, const uint32_t theCounter)
     Construct a valid UID. Called internally by BRepGraphInc_Storage::AllocateNodeUID().
    bool IsValid () const
     True if this UID has a valid kind and a non-zero counter.
    bool IsTopology () const
    bool IsAssembly () const
    size_t HashValue () const noexcept
     Hash value compatible with operator==.

    Static Public Member Functions

    static BRepGraph_UID Invalid ()
     Factory: returns an explicitly invalid UID.

    Data Fields

    BRepGraph_NodeId::Kind Kind = BRepGraph_NodeId::Kind::Solid
    uint32_t Counter = 0

    Detailed Description

    Unique definition-node identifier within a BRepGraph.

    Identity = (Kind, Counter). Two nodes of different kinds may share a counter value but their UIDs are distinct. Within one kind, counter values never repeat (monotonic, never resets).

    Trivially copyable, cheap to pass by value.

    Constructor & Destructor Documentation

    ◆ BRepGraph_UID() [1/2]

    BRepGraph_UID::BRepGraph_UID ( )
    		default

    Default: invalid UID (counter = 0 is the invalid sentinel).

    ◆ BRepGraph_UID() [2/2]

    BRepGraph_UID::BRepGraph_UID ( const BRepGraph_NodeId::Kind theKind,
    const uint32_t theCounter )
    		inline

    Construct a valid UID. Called internally by BRepGraphInc_Storage::AllocateNodeUID().

    Precondition
    theCounter > 0 (counter = 0 is reserved as the invalid sentinel)

    Member Function Documentation

    ◆ HashValue()

    size_t BRepGraph_UID::HashValue ( ) const
    		inlinenodiscardnoexcept

    Hash value compatible with operator==.

    ◆ Invalid()

    BRepGraph_UID BRepGraph_UID::Invalid ( )
    		inlinestatic

    Factory: returns an explicitly invalid UID.

    ◆ IsAssembly()

    bool BRepGraph_UID::IsAssembly ( ) const
    		inlinenodiscard

    ◆ IsTopology()

    bool BRepGraph_UID::IsTopology ( ) const
    		inlinenodiscard

    ◆ IsValid()

    bool BRepGraph_UID::IsValid ( ) const
    		inlinenodiscard

    True if this UID has a valid kind and a non-zero counter.

    Field Documentation

    ◆ Counter

    uint32_t BRepGraph_UID::Counter = 0

    ◆ Kind

    BRepGraph_NodeId::Kind BRepGraph_UID::Kind = BRepGraph_NodeId::Kind::Solid
    The documentation for this struct was generated from the following file: