Struct ObstacleToken

Namespace

GridForge

Assembly

GridForge.dll

Opaque process-unique identity for one obstacle registration lifetime.

public readonly struct ObstacleToken : IEquatable<ObstacleToken>

Implements

IEquatable<ObstacleToken>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Properties

IsValid

Indicates whether this token identifies an allocated obstacle registration.

public bool IsValid { get; }

Property Value

bool

Methods

Equals(ObstacleToken)

public bool Equals(ObstacleToken other)

Parameters

other ObstacleToken

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

Returns the runtime token value for diagnostics.

public override string ToString()

Returns

string

Operators

operator ==(ObstacleToken, ObstacleToken)

Compares two obstacle registration tokens for equality.

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

Parameters

left ObstacleToken

right ObstacleToken

Returns

bool

operator !=(ObstacleToken, ObstacleToken)

Compares two obstacle registration tokens for inequality.

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

Parameters

left ObstacleToken

right ObstacleToken

Returns

bool