Class EventPayload

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

Inheritance
System.Object
EventPayload
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: AasCore.Aas3_0
Assembly: AasCore.Aas3_0.dll
Syntax
public class EventPayload : IEventPayload, IClass
Remarks

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

Constructors

| Improve this Doc View Source

EventPayload(IReference, IReference, String, IReference, IReference, String, IReference, Byte[])

Declaration
public EventPayload(IReference source, IReference observableReference, string timeStamp, IReference sourceSemanticId = null, IReference observableSemanticId = null, string topic = null, IReference subjectId = null, byte[] payload = null)
Parameters
Type Name Description
IReference source
IReference observableReference
System.String timeStamp
IReference sourceSemanticId
IReference observableSemanticId
System.String topic
IReference subjectId
System.Byte[] payload

Properties

| Improve this Doc View Source

ObservableReference

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

Declaration
public IReference ObservableReference { get; set; }
Property Value
Type Description
IReference
Remarks

Can be AssetAdministrationShell, Submodel or ISubmodelElement.

| Improve this Doc View Source

ObservableSemanticId

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

Declaration
public IReference ObservableSemanticId { get; set; }
Property Value
Type Description
IReference
Remarks

It is recommended to use a global reference.

| Improve this Doc View Source

Payload

Event specific payload.

Declaration
public byte[] Payload { get; set; }
Property Value
Type Description
System.Byte[]
| Improve this Doc View Source

Source

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

Declaration
public IReference Source { get; set; }
Property Value
Type Description
IReference
| Improve this Doc View Source

SourceSemanticId

SemanticId of the source event element, if available

Declaration
public IReference SourceSemanticId { get; set; }
Property Value
Type Description
IReference
Remarks

It is recommended to use a global reference.

| Improve this Doc View Source

SubjectId

Subject, who/which initiated the creation.

Declaration
public IReference SubjectId { get; set; }
Property Value
Type Description
IReference
Remarks

This is an external reference.

| Improve this Doc View Source

TimeStamp

Timestamp in UTC, when this event was triggered.

Declaration
public string TimeStamp { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Topic

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

Declaration
public string Topic { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

Accept(Visitation.IVisitor)

Accept the visitor to visit this instance for double dispatch.

Declaration
public void Accept(Visitation.IVisitor visitor)
Parameters
Type Name Description
Visitation.IVisitor visitor
| Improve this Doc View Source

Accept<TContext>(Visitation.IVisitorWithContext<TContext>, TContext)

Accept the visitor to visit this instance for double dispatch with the context.

Declaration
public void Accept<TContext>(Visitation.IVisitorWithContext<TContext> visitor, TContext context)
Parameters
Type Name Description
Visitation.IVisitorWithContext<TContext> visitor
TContext context
Type Parameters
Name Description
TContext
| Improve this Doc View Source

Descend()

Iterate recursively over all the class instances referenced from this instance.

Declaration
public IEnumerable<IClass> Descend()
Returns
Type Description
System.Collections.Generic.IEnumerable<IClass>
| Improve this Doc View Source

DescendOnce()

Iterate over all the class instances referenced from this instance without further recursion.

Declaration
public IEnumerable<IClass> DescendOnce()
Returns
Type Description
System.Collections.Generic.IEnumerable<IClass>
| Improve this Doc View Source

Transform<T>(Visitation.ITransformer<T>)

Accept the transformer to transform this instance for double dispatch.

Declaration
public T Transform<T>(Visitation.ITransformer<T> transformer)
Parameters
Type Name Description
Visitation.ITransformer<T> transformer
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T>, TContext)

Accept the transformer to visit this instance for double dispatch with the context.

Declaration
public T Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T> transformer, TContext context)
Parameters
Type Name Description
Visitation.ITransformerWithContext<TContext, T> transformer
TContext context
Returns
Type Description
T
Type Parameters
Name Description
TContext
T

Implements