SimIdGenerator Class Reference

Thread-safe Meyers singleton for generating unique object IDs. More...

#include "sim_id.h"

Public Member Functions
SimId	generateId (ObjectType type)
	Generate a unique SimId for a given object type.
SimId	generateDebugId ()
	Generate a debug SimId.

Static Public Member Functions
static SimIdGenerator &	instance ()
	Get the singleton instance of SimIdGenerator.
static ObjectType	getType (const SimId id)
	Extract object type from SimId.
static uint64_t	getCounter (const SimId id)
	Extract counter from SimId.

Detailed Description

Thread-safe Meyers singleton for generating unique object IDs.

Definition at line 41 of file sim_id.h.

Member Function Documentation

generateDebugId()

SimId SimIdGenerator::generateDebugId

(

)

Generate a debug SimId.

Returns

A unique SimId with ObjectType::Debug.

Definition at line 84 of file sim_id.h.

    {
        // Increment 48-bit counter
        uint64_t count = _counter.fetch_add(1, std::memory_order_relaxed);
        constexpr uint64_t MAX_COUNTER_VALUE = 0x0000FFFFFFFFFFFF;
        if (count >= MAX_COUNTER_VALUE)
        {
            throw std::overflow_error("FERS object ID counter has overflowed the 48-bit space.");
        }
 
        // The mask is technically redundant due to the check above
        count &= MAX_COUNTER_VALUE;
 
        // Shift debug type into upper 16 bits
        constexpr uint64_t type_bits = static_cast<uint64_t>(ObjectType::Debug) << 48;
        return type_bits | count;
    }

References Debug.

generateId()

SimId SimIdGenerator::generateId

(

ObjectType

type

)

Generate a unique SimId for a given object type.

Parameters

type	The ObjectType for which to generate the ID.

Returns

A unique SimId.

Exceptions

std::overflow_error

if the 48-bit counter overflows.

Definition at line 60 of file sim_id.h.

    {
        assert(type != ObjectType::Debug && "generateId called with reserved ObjectType::Debug");
 
        // Increment 48-bit counter
        uint64_t count = _counter.fetch_add(1, std::memory_order_relaxed);
        constexpr uint64_t MAX_COUNTER_VALUE = 0x0000FFFFFFFFFFFF;
        if (count >= MAX_COUNTER_VALUE)
        {
            throw std::overflow_error("FERS object ID counter has overflowed the 48-bit space.");
        }
 
        // The mask is technically redundant due to the check above
        count &= MAX_COUNTER_VALUE;
 
        // Shift type into upper 16 bits
        const uint64_t type_bits = static_cast<uint64_t>(type) << 48;
        return type_bits | count;
    }

References Debug.

Referenced by serial::xml_parser_utils::assign_id_from_attribute().

Here is the caller graph for this function:

getCounter()

static uint64_t SimIdGenerator::getCounter ( const SimId  id )

static

Extract counter from SimId.

Definition at line 110 of file sim_id.h.

{ return id & 0x0000FFFFFFFFFFFF; }

getType()

static ObjectType SimIdGenerator::getType ( const SimId  id )

static

Extract object type from SimId.

Definition at line 105 of file sim_id.h.

{ return static_cast<ObjectType>(id >> 48); }

instance()

static SimIdGenerator & SimIdGenerator::instance ( )

static

Get the singleton instance of SimIdGenerator.

Returns

Reference to the SimIdGenerator instance.

Definition at line 48 of file sim_id.h.

    {
        static SimIdGenerator instance;
        return instance;
    }

References instance().

Referenced by serial::xml_parser_utils::assign_id_from_attribute(), and instance().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• packages/libfers/src/core/sim_id.h