Skip to content

TEntryValueUninit<TKey, TValue>

Wrapper around an uninitialized entry value that can be used for a zero-copy update.

Definition

Unit: Neslib.Iceoryx2.Blackboard

type TEntryValueUninit<TKey, TValue> = record ... end;

Type Parameters

TKey:

TValue:

Nested Types

Name Description
PValue

Properties

Name Description
Handle

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
AssumeInitAndUpdate Consumes the TEntryValueUninit, makes the new value accessible and returns the original TEntryHandleMut.
Discard Discard the TEntryValueUninit and returns the original TEntryHandleMut.
LoanUninit Consumes the given TEntryHandleMut and loans an uninitialized entry value that can be used to update without copy.
UpdateWithCopy Consumes the TEntryValueUninit, writes value to the entry value and returns the original TEntryHandleMut.
ValueMut Returns a reference to the value of the blackboard entry. It can be used to update the value without copy. After writing, AssumeInitAndUpdate must be called.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Constructor Descriptions

Assign

constructor Assign(var ADest: TEntryValueUninit<TKey, TValue>; const ASrc: TEntryValueUninit<TKey, TValue>)

Parameters

ADest: TEntryValueUninit<TKey, TValue>

ASrc: TEntryValueUninit<TKey, TValue>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TEntryValueUninit, Pointer)

class operator Equal(const ALeft: TEntryValueUninit<TKey, TValue>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TEntryValueUninit<TKey, TValue>

ARight: Pointer

Returns

Boolean


NotEqual(TEntryValueUninit, Pointer)

class operator NotEqual(const ALeft: TEntryValueUninit<TKey, TValue>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TEntryValueUninit<TKey, TValue>

ARight: Pointer

Returns

Boolean


Method Descriptions

AssumeInitAndUpdate

Consumes the TEntryValueUninit, makes the new value accessible and returns the original TEntryHandleMut.

function AssumeInitAndUpdate: TEntryHandleMut<TKey, TValue>; inline

Returns

TEntryHandleMut<TKey, TValue>


Discard

Discard the TEntryValueUninit and returns the original TEntryHandleMut.

function Discard: TEntryHandleMut<TKey, TValue>; inline

Returns

TEntryHandleMut<TKey, TValue>


LoanUninit(TEntryHandleMut<TKey, TValue>)

Consumes the given TEntryHandleMut and loans an uninitialized entry value that can be used to update without copy.

class function LoanUninit(const AEntryHandle: TEntryHandleMut<TKey, TValue>): TEntryValueUninit<TKey, TValue>; inline; static

Parameters

AEntryHandle: TEntryHandleMut<TKey, TValue>

Returns

TEntryValueUninit<TKey, TValue>


UpdateWithCopy(TValue)

Consumes the TEntryValueUninit, writes value to the entry value and returns the original TEntryHandleMut.

function UpdateWithCopy(const AValue: TValue): TEntryHandleMut<TKey, TValue>; inline

Parameters

AValue: TValue

Returns

TEntryHandleMut<TKey, TValue>


ValueMut

Returns a reference to the value of the blackboard entry. It can be used to update the value without copy. After writing, AssumeInitAndUpdate must be called.

function ValueMut: PValue; inline

Returns

PValue