Package aas_core.aas3_0.enhancing

Class EnhancedEventPayload<EnhancementT>

java.lang.Object

aas_core.aas3_0.enhancing.Enhanced<EnhancementT>

aas_core.aas3_0.enhancing.EnhancedEventPayload<EnhancementT>

All Implemented Interfaces:

IClass, IEventPayload

public class EnhancedEventPayload<EnhancementT>
extends Enhanced<EnhancementT>
implements IEventPayload

Field Summary

Fields inherited from class aas_core.aas3_0.enhancing.Enhanced

enhancement

Constructor Summary

Constructors

Constructor	Description
EnhancedEventPayload(IEventPayload instance, EnhancementT enhancement)

Method Summary

Modifier and Type	Method	Description
void	accept(IVisitor visitor)	Accept the visitor to visit this instance for double dispatch.
<ContextT> void	accept(IVisitorWithContext<ContextT> visitor, ContextT context)	Accept the visitor to visit this instance for double dispatch with the context.
Iterable<IClass>	descend()	Iterate recursively over all the class instances referenced from this instance.
Iterable<IClass>	descendOnce()	Iterate over all the class instances referenced from this instance without further recursion.
IReference	getObservableReference()	Reference to the referable, which defines the scope of the event.
Optional<IReference>	getObservableSemanticId()	IHasSemantics.getSemanticId() of the referable which defines the scope of the event, if available.
Optional<byte[]>	getPayload()	Event specific payload.
IReference	getSource()	Reference to the source event element, including identification of AssetAdministrationShell, Submodel, ISubmodelElement's.
Optional<IReference>	getSourceSemanticId()	IHasSemantics.getSemanticId() of the source event element, if available
Optional<IReference>	getSubjectId()	Subject, who/which initiated the creation.
String	getTimeStamp()	Timestamp in UTC, when this event was triggered.
Optional<String>	getTopic()	Information for the outer message infrastructure for scheduling the event to the respective communication channel.
void	setObservableReference(IReference observableReference)
void	setObservableSemanticId(IReference observableSemanticId)
void	setPayload(byte[] payload)
void	setSource(IReference source)
void	setSourceSemanticId(IReference sourceSemanticId)
void	setSubjectId(IReference subjectId)
void	setTimeStamp(String timeStamp)
void	setTopic(String topic)
<T> T	transform(ITransformer<T> transformer)	Accept the transformer to transform this instance for double dispatch.
<ContextT, T> T	transform(ITransformerWithContext<ContextT,T> transformer, ContextT context)	Accept the transformer to visit this instance for double dispatch with the context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnhancedEventPayload

public EnhancedEventPayload(IEventPayload instance,
 EnhancementT enhancement)

Method Details

getSource

public IReference getSource()

Description copied from interface: IEventPayload

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

Specified by:

getSource in interface IEventPayload

setSource

public void setSource(IReference source)

Specified by:

setSource in interface IEventPayload

getSourceSemanticId

public Optional<IReference> getSourceSemanticId()

Description copied from interface: IEventPayload

IHasSemantics.getSemanticId() of the source event element, if available

It is recommended to use a global reference.

Specified by:

getSourceSemanticId in interface IEventPayload

setSourceSemanticId

public void setSourceSemanticId(IReference sourceSemanticId)

Specified by:

setSourceSemanticId in interface IEventPayload

getObservableReference

public IReference getObservableReference()

Description copied from interface: IEventPayload

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

Can be AssetAdministrationShell, Submodel or ISubmodelElement.

Specified by:

getObservableReference in interface IEventPayload

setObservableReference

public void setObservableReference(IReference observableReference)

Specified by:

setObservableReference in interface IEventPayload

getObservableSemanticId

public Optional<IReference> getObservableSemanticId()

Description copied from interface: IEventPayload

IHasSemantics.getSemanticId() of the referable which defines the scope of the event, if available.

It is recommended to use a global reference.

Specified by:

getObservableSemanticId in interface IEventPayload

setObservableSemanticId

public void setObservableSemanticId(IReference observableSemanticId)

Specified by:

setObservableSemanticId in interface IEventPayload

getTopic

public Optional<String> getTopic()

Description copied from interface: IEventPayload

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

Specified by:

getTopic in interface IEventPayload

setTopic

public void setTopic(String topic)

Specified by:

setTopic in interface IEventPayload

getSubjectId

public Optional<IReference> getSubjectId()

Description copied from interface: IEventPayload

Subject, who/which initiated the creation.

This is an external reference.

Specified by:

getSubjectId in interface IEventPayload

setSubjectId

public void setSubjectId(IReference subjectId)

Specified by:

setSubjectId in interface IEventPayload

getTimeStamp

public String getTimeStamp()

Description copied from interface: IEventPayload

Timestamp in UTC, when this event was triggered.

Specified by:

getTimeStamp in interface IEventPayload

setTimeStamp

public void setTimeStamp(String timeStamp)

Specified by:

setTimeStamp in interface IEventPayload

getPayload

public Optional<byte[]> getPayload()

Description copied from interface: IEventPayload

Event specific payload.

Specified by:

getPayload in interface IEventPayload

setPayload

public void setPayload(byte[] payload)

Specified by:

setPayload in interface IEventPayload

descendOnce

public Iterable<IClass> descendOnce()

Description copied from interface: IClass

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

Specified by:

descendOnce in interface IClass

descend

public Iterable<IClass> descend()

Description copied from interface: IClass

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

Specified by:

descend in interface IClass

accept

public void accept(IVisitor visitor)

Description copied from interface: IClass

Accept the visitor to visit this instance for double dispatch.

Specified by:

accept in interface IClass

accept

public <ContextT> void accept(IVisitorWithContext<ContextT> visitor,
 ContextT context)

Description copied from interface: IClass

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

Specified by:

accept in interface IClass

transform

public <T> T transform(ITransformer<T> transformer)

Description copied from interface: IClass

Accept the transformer to transform this instance for double dispatch.

Specified by:

transform in interface IClass

transform

public <ContextT,
T> T transform(ITransformerWithContext<ContextT,T> transformer,
 ContextT context)

Description copied from interface: IClass

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

Specified by:

transform in interface IClass