Skip to content

TWriter<TKey>

Producing endpoint of a blackboard based communication.

Definition

Unit: Neslib.Iceoryx2.Blackboard

type TWriter<TKey> = record ... end;

Type Parameters

TKey:

Properties

Name Description
Handle
Id Returns the TUniqueWriterId of the TWriter
Name Returns the TPortNameView of the TWriter

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Entry<TValue> Creates a TEntryHandleMut for direct write access to the value. There can be only one TEntryHandleMut per value.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Id

Returns the TUniqueWriterId of the TWriter

property Id: TUniqueWriterId read GetId

Type: TUniqueWriterId


Name

Returns the TPortNameView of the TWriter

property Name: TPortNameView read GetName

Type: TPortNameView


Constructor Descriptions

Assign

constructor Assign(var ADest: TWriter<TKey>; const ASrc: TWriter<TKey>)

Parameters

ADest: TWriter<TKey>

ASrc: TWriter<TKey>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TWriter, Pointer)

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

Parameters

ALeft: TWriter<TKey>

ARight: Pointer

Returns

Boolean


NotEqual(TWriter, Pointer)

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

Parameters

ALeft: TWriter<TKey>

ARight: Pointer

Returns

Boolean


Method Descriptions

Entry<TValue>(TKey)

Creates a TEntryHandleMut for direct write access to the value. There can be only one TEntryHandleMut per value.

function Entry<TValue>(const AKey: TKey): TResult<TEntryHandleMut<TKey>, TEntryHandleMutError>; inline

Type Parameters

TValue:

Parameters

AKey: TKey

Returns

TResult<TEntryHandleMut<TKey>, TEntryHandleMutError>