Struct GuideSampleWorkBudget

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines finite deterministic work limits for one guide sampling operation.

public readonly struct GuideSampleWorkBudget : IEquatable<GuideSampleWorkBudget>

Implements

IEquatable<GuideSampleWorkBudget>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

GuideSampleWorkBudget(int, int, int, int, int, int, int)

Creates a finite guide sample work budget. Zero disables the corresponding category of work.

public GuideSampleWorkBudget(int maxCurrentNodeLookupProbes, int maxCursorLegScans, int maxCursorRebases, int maxPortalChecks, int maxPrismChecks, int maxTraceIntervals, int maxLocalRecoveryAttempts)

Parameters

maxCurrentNodeLookupProbes int

maxCursorLegScans int

maxCursorRebases int

maxPortalChecks int

maxPrismChecks int

maxTraceIntervals int

maxLocalRecoveryAttempts int

Exceptions

ArgumentOutOfRangeException

Thrown when any limit is negative.

Properties

MaxCurrentNodeLookupProbes

Gets the maximum number of current-node lookup probes.

public int MaxCurrentNodeLookupProbes { get; }

Property Value

int

MaxCursorLegScans

Gets the maximum number of cursor-leg scans.

public int MaxCursorLegScans { get; }

Property Value

int

MaxCursorRebases

Gets the maximum number of cursor rebases.

public int MaxCursorRebases { get; }

Property Value

int

MaxLocalRecoveryAttempts

Gets the maximum number of local recovery attempts.

public int MaxLocalRecoveryAttempts { get; }

Property Value

int

MaxPortalChecks

Gets the maximum number of portal checks.

public int MaxPortalChecks { get; }

Property Value

int

MaxPrismChecks

Gets the maximum number of prism checks.

public int MaxPrismChecks { get; }

Property Value

int

MaxTraceIntervals

Gets the maximum number of trace intervals visited.

public int MaxTraceIntervals { get; }

Property Value

int

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(GuideSampleWorkBudget)

public bool Equals(GuideSampleWorkBudget other)

Parameters

other GuideSampleWorkBudget

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(GuideSampleWorkBudget, GuideSampleWorkBudget)

Returns whether two budgets have exactly equal limits.

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

Parameters

left GuideSampleWorkBudget

right GuideSampleWorkBudget

Returns

bool

operator !=(GuideSampleWorkBudget, GuideSampleWorkBudget)

Returns whether two budgets differ.

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

Parameters

left GuideSampleWorkBudget

right GuideSampleWorkBudget

Returns

bool