TEntryHandleMut<TKey, TValue>
A handle for direct write access to a specific blackboard value.
Definition
Unit: Neslib.Iceoryx2.Blackboard
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 |
|---|---|
| UpdateWithCopy | Updates the value by copying the passed value into it. |
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: TEntryHandleMut<TKey, TValue>; const ASrc: TEntryHandleMut<TKey, TValue>)
Parameters
ADest: TEntryHandleMut<TKey, TValue>
ASrc: TEntryHandleMut<TKey, TValue>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TEntryHandleMut, Pointer)
class operator Equal(const ALeft: TEntryHandleMut<TKey, TValue>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TEntryHandleMut<TKey, TValue>
ARight: Pointer
Returns
Boolean
NotEqual(TEntryHandleMut, Pointer)
class operator NotEqual(const ALeft: TEntryHandleMut<TKey, TValue>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TEntryHandleMut<TKey, TValue>
ARight: Pointer
Returns
Boolean
Method Descriptions
UpdateWithCopy(TValue)
Updates the value by copying the passed value into it.
procedure UpdateWithCopy(const AValue: TValue); overload
Parameters
AValue: TValue