Namespace simtix::sim

Namespace List > simtix > sim

Classes

Type	Name
class	Clocked Abstract base class for tick-driven simulation objects.
class	DelayQueue <class T, class Alloc>
class	FcfsDelayQueue <class T, class Alloc>
class	GenericDelayQueue <class T, class Alloc>
class	SizedQueue <class T, class Alloc>

Public Types

Type	Name
enum int8_t	TickPri Tick priorities used to schedule and order tick-driven operations.

Public Functions

Type	Name
uint64_t	CurTick () Return the current global tick count.
bool	HasPendingTasks () Check if any registered clocked objects have pending tasks at the current tick.
void	Tick () Global tick function that advances the simulation by one cycle.

Public Types Documentation

enum TickPri

Tick priorities used to schedule and order tick-driven operations.

enum simtix::sim::TickPri {
    kMaximumPri = INT8_MIN,
    kTraceTickPri = -100,
    kMemTickPri = -20,
    kSmTickPri = -10,
    kDefaultPri = 0,
    kSimTickPri = 30,
    kMinimumPri = INT8_MAX
};

A lower value indicates a higher priority. These values determine the order of tick function calls within a cycle. Most ticks are scheduled at the default priority unless specified otherwise.

---

Public Functions Documentation

function CurTick

Return the current global tick count.

uint64_t simtix::sim::CurTick () 

Returns:

The number of ticks executed since simulation start.

---

function HasPendingTasks

Check if any registered clocked objects have pending tasks at the current tick.

bool simtix::sim::HasPendingTasks () 

Returns:

True if there are pending tasks, false otherwise.

---

function Tick

Global tick function that advances the simulation by one cycle.

void simtix::sim::Tick () 

Call this function to drive the simulation forward.

---

---

The documentation for this class was generated from the following file projects/simtix/include/simtix/clocked.h