Table of Contents

Struct SystemStat

Namespace
Typhon.Engine
Assembly
Typhon.Engine.dll

One system's mean cost over the window, and the rate it runs at.

public readonly struct SystemStat : IEquatable<SystemStat>
Implements
Inherited Members

Constructors

SystemStat(string, double, int, int)

One system's mean cost over the window, and the rate it runs at.

public SystemStat(string Name, double MeanUs, int TickDivisor, int TickOffset)

Parameters

Name string

The system's name, as the schedule declares it.

MeanUs double

Mean duration over the window, in microseconds.

TickDivisor int

How many ticks apart its runs are by declaration; 1 for a system that runs every tick.

TickOffset int

Which of those ticks it runs on — the phase RuntimeSchedule.Build assigned it (DSEL-04), or the one it asked for. Reported because the assignment is automatic and spreads a schedule's slow work across phases: without it there is no way to answer "why did this system run on tick 7", and a stagger nobody can see is a stagger nobody can debug. Always 0 at divisor 1.

Properties

MeanUs

Mean duration over the window, in microseconds.

public double MeanUs { get; init; }

Property Value

double

Name

The system's name, as the schedule declares it.

public string Name { get; init; }

Property Value

string

TickDivisor

How many ticks apart its runs are by declaration; 1 for a system that runs every tick.

public int TickDivisor { get; init; }

Property Value

int

TickOffset

Which of those ticks it runs on — the phase RuntimeSchedule.Build assigned it (DSEL-04), or the one it asked for. Reported because the assignment is automatic and spreads a schedule's slow work across phases: without it there is no way to answer "why did this system run on tick 7", and a stagger nobody can see is a stagger nobody can debug. Always 0 at divisor 1.

public int TickOffset { get; init; }

Property Value

int

Methods

Deconstruct(out string, out double, out int, out int)

public void Deconstruct(out string Name, out double MeanUs, out int TickDivisor, out int TickOffset)

Parameters

Name string
MeanUs double
TickDivisor int
TickOffset int

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(SystemStat)

public bool Equals(SystemStat other)

Parameters

other SystemStat

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(SystemStat, SystemStat)

public static bool operator ==(SystemStat left, SystemStat right)

Parameters

left SystemStat
right SystemStat

Returns

bool

operator !=(SystemStat, SystemStat)

public static bool operator !=(SystemStat left, SystemStat right)

Parameters

left SystemStat
right SystemStat

Returns

bool