Skip to content

TEntryHandle<TKey, TValue>

A handle for direct read access to a specific blackboard value.

Definition

Unit: Neslib.Iceoryx2.Blackboard

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

Type Parameters

TKey:

TValue:

Properties

Name Description
EntryId Returns an ID corresponding to the entry which can be used in an event based communication setup.
Handle

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Get Returns a copy of the value wrapped in a TBlackboardValue.
IsUpToDate Checks if the passed AValue is up-to-date.

Property Descriptions

EntryId

Returns an ID corresponding to the entry which can be used in an event based communication setup.

property EntryId: TEventId read GetEntryId

Type: TEventId


Handle

property Handle: THandle read GetHandle

Type: THandle


Constructor Descriptions

Assign

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

Parameters

ADest: TEntryHandle<TKey, TValue>

ASrc: TEntryHandle<TKey, TValue>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TEntryHandle, Pointer)

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

Parameters

ALeft: TEntryHandle<TKey, TValue>

ARight: Pointer

Returns

Boolean


NotEqual(TEntryHandle, Pointer)

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

Parameters

ALeft: TEntryHandle<TKey, TValue>

ARight: Pointer

Returns

Boolean


Method Descriptions

Get

Returns a copy of the value wrapped in a TBlackboardValue.

function Get: TBlackboardValue<TValue>; inline

Returns

TBlackboardValue<TValue>


IsUpToDate(TBlackboardValue<TValue>)

Checks if the passed AValue is up-to-date.

function IsUpToDate(const AValue: TBlackboardValue<TValue>): Boolean; inline

Parameters

AValue: TBlackboardValue<TValue>

Returns

Boolean