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

uniqueIdentifier

Denotes the handle used to identify a data type element. It's a combination of index of the memory block in memory chunk and a unique version to differentiate blocks with same index because of re-allocation

Declaration
public int uniqueIdentifier
Field Value
Type Description
Int32

Properties

index

Index of the corresponding memory block in the memory chunk. Negative value means the identifier is invalid

Declaration
public short index { get; }
Property Value
Type Description
Int16

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.

version

When memory chunk re-allocates a block with same index, it will increment the version to ensure previously deleted block and re-allocated block don't share the same identifier

Declaration
public short version { get; }
Property Value
Type Description
Int16

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

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.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Operators

Equality(MemoryIdentifier, MemoryIdentifier)

Declaration
public static bool operator ==(MemoryIdentifier id1, MemoryIdentifier id2)
Parameters
Type Name Description
MemoryIdentifier id1
MemoryIdentifier id2
Returns
Type Description
Boolean

Inequality(MemoryIdentifier, MemoryIdentifier)

Declaration
public static bool operator !=(MemoryIdentifier id1, MemoryIdentifier id2)
Parameters
Type Name Description
MemoryIdentifier id1
MemoryIdentifier id2
Returns
Type Description
Boolean

See Also