Struct MemoryIdentifier

Memory identifiers are used to uniquely identify data types and tasks that are part of Kinematica's task graph.

Namespace: Unity.Kinematica
Syntax
public struct MemoryIdentifier

Fields

index

Denotes the handle used to identify a data type element.

Declaration
public short index
Field Value
Type Description
Int16

Properties

Invalid

Invalid memory identifier.

Declaration
public static MemoryIdentifier Invalid { get; }
Property Value
Type Description
MemoryIdentifier

IsValid

Determines if the given memory identifier is valid or not.

Declaration
public bool IsValid { get; }
Property Value
Type Description
Boolean

True if the memory identifier is valid; false otherwise.

Methods

Equals(MemoryIdentifier)

Determines whether two memory identifiers are equal.

Declaration
public bool Equals(MemoryIdentifier identifier)
Parameters
Type Name Description
MemoryIdentifier identifier

The memory identifier to compare against the current memory identifier.
Returns
Type Description
Boolean

True if the specified memory identifier is equal to the current memory identifier; otherwise, false.

Operators

Implicit(Int16 to MemoryIdentifier)

Implicit conversion from a short to a memory identifier.

Declaration
public static implicit operator MemoryIdentifier(short index)
Parameters
Type Name Description
Int16 index
Returns
Type Description
MemoryIdentifier

Implicit(MemoryIdentifier to Int16)

Implicit conversion from a memory identifier to a short.

Declaration
public static implicit operator short (MemoryIdentifier identifier)
Parameters
Type Name Description
MemoryIdentifier identifier
Returns
Type Description
Int16

See Also