Class GridCoveredAddressCursor

Namespace

GridForge.Grids.Topology

Assembly

GridForge.dll

Stores caller-owned bounded progress for a value-only covered-address query.

public sealed class GridCoveredAddressCursor

Inheritance

object

GridCoveredAddressCursor

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Construct with the maximum eligible generation count, begin through GridWorld, then supply the next canonical generation-input slice to each advance call until it is consumed. Once all declared generations are bound, pass an empty input span. The cursor retains no live grid or voxel.

Constructors

GridCoveredAddressCursor(int)

Initializes reusable storage for at most generationCapacity eligible grids.

public GridCoveredAddressCursor(int generationCapacity)

Parameters

generationCapacity int

Properties

AddressProbeOrdinal

The cumulative number of topology-address probes.

public ulong AddressProbeOrdinal { get; }

Property Value

ulong

GenerationCapacity

The maximum eligible generation count accepted by this cursor.

public int GenerationCapacity { get; }

Property Value

int

LookupProbeOrdinal

The cumulative number of generation validation and spatial lookup probes.

public ulong LookupProbeOrdinal { get; }

Property Value

ulong

OutputOrdinal

The cumulative number of covered addresses emitted.

public ulong OutputOrdinal { get; }

Property Value

ulong

RetainedBytes

The deterministic logical bytes retained by this cursor and its owned generation storage.

public long RetainedBytes { get; }

Property Value

long

Remarks

Shared empty-array storage is not charged.

RunStamp

The exact committed world revision bound by this cursor.

public GridCoveredAddressRunStamp RunStamp { get; }

Property Value

GridCoveredAddressRunStamp

Status

The current query state.

public GridCoveredAddressCursorStatus Status { get; }

Property Value

GridCoveredAddressCursorStatus