Class EventPayload

Defines the necessary information of an event instance sent out or received.

Remarks

Note: This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.

Hierarchy

Class
- EventPayload

Index

Constructors

constructor

new EventPayload(source: Reference, observableReference: Reference, timeStamp: string, sourceSemanticId?: Reference, observableSemanticId?: Reference, topic?: string, subjectId?: Reference, payload?: Uint8Array): EventPayload
Parameters
- source: Reference
- observableReference: Reference
- timeStamp: string
- sourceSemanticId: Reference = null
- observableSemanticId: Reference = null
- topic: string = null
- subjectId: Reference = null
- payload: Uint8Array = null
Returns EventPayload
Overrides Class.constructor
- Defined in types.ts:7084

Properties

observableReference

observableReference: Reference

Reference to the referable, which defines the scope of the event.

Remarks

Can be AssetAdministrationShell, Submodel or ISubmodelElement.

observableSemanticId

observableSemanticId: Reference

semanticId of the referable which defines the scope of the event, if available.

Remarks

Note: It is recommended to use a global reference.

payload

payload: Uint8Array

Event specific payload.

source

source: Reference

Reference to the source event element, including identification of AssetAdministrationShell, Submodel, ISubmodelElement's.

sourceSemanticId

sourceSemanticId: Reference

semanticId of the source event element, if available

Remarks

Note: It is recommended to use a global reference.

subjectId

subjectId: Reference

Subject, who/which initiated the creation.

Remarks

Note: This is an external reference.

timeStamp

timeStamp: string

Timestamp in UTC, when this event was triggered.

topic

topic: string

Information for the outer message infrastructure for scheduling the event to the respective communication channel.

Methods

accept

accept(visitor: AbstractVisitor): void
Dispatch visitor on this instance.
Parameters
- visitor: AbstractVisitor
  
  to visit this instance
Returns void
Overrides Class.accept
- Defined in types.ts:7039

acceptWithContext

acceptWithContext<ContextT>(visitor: AbstractVisitorWithContext<ContextT>, context: ContextT): void
Dispatch visitor with context on this instance.
Type Parameters
- ContextT
  
  type of the context
Parameters
- visitor: AbstractVisitorWithContext<ContextT>
  
  to visit this instance
- context: ContextT
  
  to be passed along to the dispatched visitor method
Returns void
Overrides Class.acceptWithContext
- Defined in types.ts:7050

descend

descend(): IterableIterator<Class>
Iterate recursively over the instances referenced from this instance.

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Overrides Class.descend
- Defined in types.ts:7006

descendOnce

descendOnce(): IterableIterator<Class>
Iterate over the instances referenced from this instance.

We do not recurse into the referenced instances.

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Overrides Class.descendOnce
- Defined in types.ts:6983

modelType

modelType(): ModelType
Indicate the runtime model type of the instance.

Returns ModelType
Overrides Class.modelType
- Defined in types.ts:6909

transform

transform<T>(transformer: AbstractTransformer<T>): T
Dispatch the transformer on this instance.

Returns
transformation of this instance

Param Type
T - type of the transformation result
Type Parameters
- T
Parameters
- transformer: AbstractTransformer<T>
  
  to transform this instance
Returns T
Overrides Class.transform
- Defined in types.ts:7064

transformWithContext

transformWithContext<ContextT, T>(transformer: AbstractTransformerWithContext<ContextT, T>, context: ContextT): T
Dispatch the transformer on this instance in context.

Returns
transformation of this instance

Param Type
T - type of the transformation result

Param Type
ContextT - type of the transformation context
Type Parameters
- ContextT
- T
Parameters
- transformer: AbstractTransformerWithContext<ContextT, T>
  
  to transform this instance
- context: ContextT
  
  to be passed along to the transformer
Returns T
Overrides Class.transformWithContext
- Defined in types.ts:7077

Class EventPayload

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

source: Reference

observableReference: Reference

timeStamp: string

sourceSemanticId: Reference = null

observableSemanticId: Reference = null

topic: string = null

subjectId: Reference = null

payload: Uint8Array = null

Returns EventPayload

Properties

observableReference

Remarks

observableSemanticId

Remarks

payload

source

sourceSemanticId

Remarks

subjectId

Remarks

timeStamp

topic

Methods

accept

Parameters

visitor: AbstractVisitor

Returns void

acceptWithContext

Type Parameters

ContextT

Parameters

visitor: AbstractVisitorWithContext<ContextT>

context: ContextT

Returns void

descend

Returns

Returns IterableIterator<Class>

descendOnce

Returns

Returns IterableIterator<Class>

modelType

Returns ModelType

transform

Returns

Param Type

Type Parameters

T

Parameters

transformer: AbstractTransformer<T>

Returns T

transformWithContext

Returns

Param Type

Param Type

Type Parameters

ContextT

T

Parameters

transformer: AbstractTransformerWithContext<ContextT, T>

context: ContextT

Returns T

Settings

Member Visibility

Theme