Package aas_core.aas3_0.enhancing

Class EnhancedBasicEventElement<EnhancementT>

java.lang.Object

aas_core.aas3_0.enhancing.Enhanced<EnhancementT>

aas_core.aas3_0.enhancing.EnhancedBasicEventElement<EnhancementT>

All Implemented Interfaces:

IBasicEventElement, IClass, IEventElement, IHasDataSpecification, IHasExtensions, IHasSemantics, IQualifiable, IReferable, ISubmodelElement

public class EnhancedBasicEventElement<EnhancementT>
extends Enhanced<EnhancementT>
implements IBasicEventElement

Field Summary

Fields inherited from class aas_core.aas3_0.enhancing.Enhanced

enhancement

Constructor Summary

Constructors

Constructor	Description
EnhancedBasicEventElement(IBasicEventElement 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.
Optional<String>	getCategory()	The category is a value that gives further meta information w.r.t. to the class of the element.
Optional<List<ILangStringTextType>>	getDescription()	Description or comments on the element.
Direction	getDirection()	Direction of event.
Optional<List<ILangStringNameType>>	getDisplayName()	Display name.
Optional<List<IEmbeddedDataSpecification>>	getEmbeddedDataSpecifications()	Embedded data specification.
Optional<List<IExtension>>	getExtensions()	An extension of the element.
Optional<String>	getIdShort()	In case of identifiables this attribute is a short name of the element.
Optional<String>	getLastUpdate()	Timestamp in UTC, when the last event was received (input direction) or sent (output direction).
Optional<String>	getMaxInterval()	For input direction: not applicable.
Optional<IReference>	getMessageBroker()	Information, which outer message infrastructure shall handle messages for the IEventElement.
Optional<String>	getMessageTopic()	Information for the outer message infrastructure for scheduling the event to the respective communication channel.
Optional<String>	getMinInterval()	For input direction, reports on the maximum frequency, the software entity behind the respective Referable can handle input events.
IReference	getObserved()	Reference to the IReferable, which defines the scope of the event.
Optional<List<IQualifier>>	getQualifiers()	Additional qualification of a qualifiable element.
Optional<IReference>	getSemanticId()	Identifier of the semantic definition of the element.
StateOfEvent	getState()	State of event.
Optional<List<IReference>>	getSupplementalSemanticIds()	Identifier of a supplemental semantic definition of the element.
Iterable<ILangStringTextType>	overDescriptionOrEmpty()	Iterate over description, if set, and otherwise return an empty enumerable.
Iterable<ILangStringNameType>	overDisplayNameOrEmpty()	Iterate over displayName, if set, and otherwise return an empty enumerable.
Iterable<IEmbeddedDataSpecification>	overEmbeddedDataSpecificationsOrEmpty()	Iterate over embeddedDataSpecifications, if set, and otherwise return an empty enumerable.
Iterable<IExtension>	overExtensionsOrEmpty()	Iterate over extensions, if set, and otherwise return an empty enumerable.
Iterable<IQualifier>	overQualifiersOrEmpty()	Iterate over qualifiers, if set, and otherwise return an empty enumerable.
Iterable<IReference>	overSupplementalSemanticIdsOrEmpty()	Iterate over supplementalSemanticIds, if set, and otherwise return an empty enumerable.
void	setCategory(String category)
void	setDescription(List<ILangStringTextType> description)
void	setDirection(Direction direction)
void	setDisplayName(List<ILangStringNameType> displayName)
void	setEmbeddedDataSpecifications(List<IEmbeddedDataSpecification> embeddedDataSpecifications)
void	setExtensions(List<IExtension> extensions)
void	setIdShort(String idShort)
void	setLastUpdate(String lastUpdate)
void	setMaxInterval(String maxInterval)
void	setMessageBroker(IReference messageBroker)
void	setMessageTopic(String messageTopic)
void	setMinInterval(String minInterval)
void	setObserved(IReference observed)
void	setQualifiers(List<IQualifier> qualifiers)
void	setSemanticId(IReference semanticId)
void	setState(StateOfEvent state)
void	setSupplementalSemanticIds(List<IReference> supplementalSemanticIds)
<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

EnhancedBasicEventElement

public EnhancedBasicEventElement(IBasicEventElement instance,
 EnhancementT enhancement)

Method Details

getExtensions

public Optional<List<IExtension>> getExtensions()

Description copied from interface: IHasExtensions

An extension of the element.

Specified by:

getExtensions in interface IHasExtensions

setExtensions

public void setExtensions(List<IExtension> extensions)

Specified by:

setExtensions in interface IHasExtensions

getCategory

public Optional<String> getCategory()

Description copied from interface: IReferable

The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints.

The category is not identical to the semantic definition (IHasSemantics) of an element. The category e.g. could denote that the element is a measurement value whereas the semantic definition of the element would denote that it is the measured temperature.

Specified by:

getCategory in interface IReferable

setCategory

public void setCategory(String category)

Specified by:

setCategory in interface IReferable

getIdShort

public Optional<String> getIdShort()

Description copied from interface: IReferable

In case of identifiables this attribute is a short name of the element. In case of referable this ID is an identifying string of the element within its name space.

In case the element is a property and the property has a semantic definition (IHasSemantics.getSemanticId()) conformant to IEC61360 the IReferable.getIdShort() is typically identical to the short name in English.

Specified by:

getIdShort in interface IReferable

setIdShort

public void setIdShort(String idShort)

Specified by:

setIdShort in interface IReferable

getDisplayName

public Optional<List<ILangStringNameType>> getDisplayName()

Description copied from interface: IReferable

Display name. Can be provided in several languages.

Specified by:

getDisplayName in interface IReferable

setDisplayName

public void setDisplayName(List<ILangStringNameType> displayName)

Specified by:

setDisplayName in interface IReferable

getDescription

public Optional<List<ILangStringTextType>> getDescription()

Description copied from interface: IReferable

Description or comments on the element.

The description can be provided in several languages.

If no description is defined, then the definition of the concept description that defines the semantics of the element is used.

Additional information can be provided, e.g., if the element is qualified and which qualifier types can be expected in which context or which additional data specification templates are provided.

Specified by:

getDescription in interface IReferable

setDescription

public void setDescription(List<ILangStringTextType> description)

Specified by:

setDescription in interface IReferable

getSemanticId

public Optional<IReference> getSemanticId()

Description copied from interface: IHasSemantics

Identifier of the semantic definition of the element. It is called semantic ID of the element or also main semantic ID of the element.

It is recommended to use a global reference.

Specified by:

getSemanticId in interface IHasSemantics

setSemanticId

public void setSemanticId(IReference semanticId)

Specified by:

setSemanticId in interface IHasSemantics

getSupplementalSemanticIds

public Optional<List<IReference>> getSupplementalSemanticIds()

Description copied from interface: IHasSemantics

Identifier of a supplemental semantic definition of the element. It is called supplemental semantic ID of the element.

It is recommended to use a global reference.

Specified by:

getSupplementalSemanticIds in interface IHasSemantics

setSupplementalSemanticIds

public void setSupplementalSemanticIds(List<IReference> supplementalSemanticIds)

Specified by:

setSupplementalSemanticIds in interface IHasSemantics

getQualifiers

public Optional<List<IQualifier>> getQualifiers()

Description copied from interface: IQualifiable

Additional qualification of a qualifiable element.

Constraints:

• Constraint AASd-021: Every qualifiable can only have one qualifier with the same Qualifier.getType().

Specified by:

getQualifiers in interface IQualifiable

setQualifiers

public void setQualifiers(List<IQualifier> qualifiers)

Specified by:

setQualifiers in interface IQualifiable

getEmbeddedDataSpecifications

public Optional<List<IEmbeddedDataSpecification>> getEmbeddedDataSpecifications()

Description copied from interface: IHasDataSpecification

Embedded data specification.

Specified by:

getEmbeddedDataSpecifications in interface IHasDataSpecification

setEmbeddedDataSpecifications

public void setEmbeddedDataSpecifications(List<IEmbeddedDataSpecification> embeddedDataSpecifications)

Specified by:

setEmbeddedDataSpecifications in interface IHasDataSpecification

getObserved

public IReference getObserved()

Description copied from interface: IBasicEventElement

Reference to the IReferable, which defines the scope of the event. Can be AssetAdministrationShell, Submodel, or ISubmodelElement.

Reference to a referable, e.g., a data element or a submodel, that is being observed.

Specified by:

getObserved in interface IBasicEventElement

setObserved

public void setObserved(IReference observed)

Specified by:

setObserved in interface IBasicEventElement

getDirection

public Direction getDirection()

Description copied from interface: IBasicEventElement

Direction of event.

Can be { Input, Output }.

Specified by:

getDirection in interface IBasicEventElement

setDirection

public void setDirection(Direction direction)

Specified by:

setDirection in interface IBasicEventElement

getState

public StateOfEvent getState()

Description copied from interface: IBasicEventElement

State of event.

Can be { On, Off }.

Specified by:

getState in interface IBasicEventElement

setState

public void setState(StateOfEvent state)

Specified by:

setState in interface IBasicEventElement

getMessageTopic

public Optional<String> getMessageTopic()

Description copied from interface: IBasicEventElement

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

Specified by:

getMessageTopic in interface IBasicEventElement

setMessageTopic

public void setMessageTopic(String messageTopic)

Specified by:

setMessageTopic in interface IBasicEventElement

getMessageBroker

public Optional<IReference> getMessageBroker()

Description copied from interface: IBasicEventElement

Information, which outer message infrastructure shall handle messages for the IEventElement. Refers to a Submodel, SubmodelElementList, SubmodelElementCollection or Entity, which contains IDataElement's describing the proprietary specification for the message broker.

For different message infrastructure, e.g., OPC UA or MQTT or AMQP, this proprietary specification could be standardized by having respective Submodels.

Specified by:

getMessageBroker in interface IBasicEventElement

setMessageBroker

public void setMessageBroker(IReference messageBroker)

Specified by:

setMessageBroker in interface IBasicEventElement

getLastUpdate

public Optional<String> getLastUpdate()

Description copied from interface: IBasicEventElement

Timestamp in UTC, when the last event was received (input direction) or sent (output direction).

Specified by:

getLastUpdate in interface IBasicEventElement

setLastUpdate

public void setLastUpdate(String lastUpdate)

Specified by:

setLastUpdate in interface IBasicEventElement

getMinInterval

public Optional<String> getMinInterval()

Description copied from interface: IBasicEventElement

For input direction, reports on the maximum frequency, the software entity behind the respective Referable can handle input events.

For output events, specifies the maximum frequency of outputting this event to an outer infrastructure.

Might be not specified, that is, there is no minimum interval.

Specified by:

getMinInterval in interface IBasicEventElement

setMinInterval

public void setMinInterval(String minInterval)

Specified by:

setMinInterval in interface IBasicEventElement

getMaxInterval

public Optional<String> getMaxInterval()

Description copied from interface: IBasicEventElement

For input direction: not applicable.

For output direction: maximum interval in time, the respective Referable shall send an update of the status of the event, even if no other trigger condition for the event was not met.

Might be not specified, that is, there is no maximum interval

Specified by:

getMaxInterval in interface IBasicEventElement

setMaxInterval

public void setMaxInterval(String maxInterval)

Specified by:

setMaxInterval in interface IBasicEventElement

overExtensionsOrEmpty

public Iterable<IExtension> overExtensionsOrEmpty()

Description copied from interface: IHasExtensions

Iterate over extensions, if set, and otherwise return an empty enumerable.

Specified by:

overExtensionsOrEmpty in interface IHasExtensions

overDisplayNameOrEmpty

public Iterable<ILangStringNameType> overDisplayNameOrEmpty()

Description copied from interface: IReferable

Iterate over displayName, if set, and otherwise return an empty enumerable.

Specified by:

overDisplayNameOrEmpty in interface IReferable

overDescriptionOrEmpty

public Iterable<ILangStringTextType> overDescriptionOrEmpty()

Description copied from interface: IReferable

Iterate over description, if set, and otherwise return an empty enumerable.

Specified by:

overDescriptionOrEmpty in interface IReferable

overSupplementalSemanticIdsOrEmpty

public Iterable<IReference> overSupplementalSemanticIdsOrEmpty()

Description copied from interface: IHasSemantics

Iterate over supplementalSemanticIds, if set, and otherwise return an empty enumerable.

Specified by:

overSupplementalSemanticIdsOrEmpty in interface IHasSemantics

overQualifiersOrEmpty

public Iterable<IQualifier> overQualifiersOrEmpty()

Description copied from interface: IQualifiable

Iterate over qualifiers, if set, and otherwise return an empty enumerable.

Specified by:

overQualifiersOrEmpty in interface IQualifiable

overEmbeddedDataSpecificationsOrEmpty

public Iterable<IEmbeddedDataSpecification> overEmbeddedDataSpecificationsOrEmpty()

Description copied from interface: IHasDataSpecification

Iterate over embeddedDataSpecifications, if set, and otherwise return an empty enumerable.

Specified by:

overEmbeddedDataSpecificationsOrEmpty in interface IHasDataSpecification

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