BasicEventElement🔗

A basic event element.

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

Inheritances 🔗

EventElement

Properties 🔗

extensions: Optional[List[Extension]] 🔗

(From HasExtensions)

An extension of the element.

category: Optional[NameType] 🔗

(From Referable)

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 (HasSemantics) 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.

idShort: Optional[IdShortType] 🔗

(From Referable)

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 (HasSemantics.semanticId) conformant to IEC61360 the Referable.idShort is typically identical to the short name in English.

displayName: Optional[List[LangStringNameType]] 🔗

(From Referable)

Display name. Can be provided in several languages.

description: Optional[List[LangStringTextType]] 🔗

(From Referable)

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.

semanticId: Optional[Reference] 🔗

(From HasSemantics)

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.

supplementalSemanticIds: Optional[List[Reference]] 🔗

(From HasSemantics)

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.

qualifiers: Optional[List[Qualifier]] 🔗

(From Qualifiable)

Additional qualification of a qualifiable element.

Constraint AASd-021🔗: Every qualifiable can only have one qualifier with the same Qualifier.type.

embeddedDataSpecifications: Optional[List[EmbeddedDataSpecification]] 🔗

(From HasDataSpecification)

Embedded data specification.

observed: Reference 🔗

Reference to the Referable, which defines the scope of the event. Can be AssetAdministrationShell, Submodel, or SubmodelElement.

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

direction: Direction 🔗

Direction of event.

Can be { Input, Output }.

state: StateOfEvent 🔗

State of event.

Can be { On, Off }.

messageTopic: Optional[MessageTopicType] 🔗

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

messageBroker: Optional[Reference] 🔗

Information, which outer message infrastructure shall handle messages for the EventElement. Refers to a Submodel, SubmodelElementList, SubmodelElementCollection or Entity, which contains DataElement'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.

lastUpdate: Optional[DateTimeUtc] 🔗

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

minInterval: Optional[Duration] 🔗

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.

maxInterval: Optional[Duration] 🔗

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

Invariants 🔗

Extensions must be either not set or have at least one item.
(From HasExtensions)
```
not (self.extensions is not None)
or (len(self.extensions) >= 1)
```
Constraint AASd-077: The name of an extension within Has-Extensions needs to be unique.
(From HasExtensions)
```
not (self.extensions is not None)
or ExtensionNamesAreUnique(
    self.extensions
)
```
Description must be either not set or have at least one item.
(From Referable)
```
not (self.description is not None)
or (len(self.description) >= 1)
```

Description must specify unique languages.
(From Referable)

not (self.description is not None)
or LangStringsHaveUniqueLanguages(
    self.description
)

Display name must be either not set or have at least one item.
(From Referable)
```
not (self.displayName is not None)
or (len(self.displayName) >= 1)
```

Display name must specify unique languages.
(From Referable)

not (self.displayName is not None)
or LangStringsHaveUniqueLanguages(
    self.displayName
)

Supplemental semantic IDs must be either not set or have at least one item.
(From HasSemantics)

not (self.supplementalSemanticIds is not None)
or (len(self.supplementalSemanticIds) >= 1)

Constraint AASd-118: If there are supplemental semantic IDs defined then there shall be also a main semantic ID.
(From HasSemantics)
```
not (self.supplementalSemanticIds is not None)
or (self.semanticId is not None)
```
Qualifiers must be either not set or have at least one item.
(From Qualifiable)
```
not (self.qualifiers is not None)
or (len(self.qualifiers) >= 1)
```
Constraint AASd-021: Every qualifiable can only have one qualifier with the same type.
(From Qualifiable)
```
not (self.qualifiers is not None)
or QualifierTypesAreUnique(
    self.qualifiers
)
```
Embedded data specifications must be either not set or have at least one item.
(From HasDataSpecification)
```
not (self.embeddedDataSpecifications is not None)
or (len(self.embeddedDataSpecifications) >= 1)
```

Max. interval is not applicable for input direction.

not (self.direction == Direction.Input)
or (self.maxInterval is None)

Observed must be a model reference to a referable.

IsModelReferenceToReferable(
    self.observed
)

Message broker must be a model reference to a referable.

not (self.messageBroker is not None)
or IsModelReferenceToReferable(
    self.messageBroker
)