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.
Note: 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.
Checksum to be used to determine if an Referable (including its aggregated child elements) has changed.
The checksum is calculated by the user's tool environment. The checksum has no semantic meaning for an asset administration shell model and there is no requirement for asset administration shell tools to manage the checksum
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.
Direction of event.
Can be { Input, Output }.
Display name. Can be provided in several languages.
If no display name is defined in the language requested by the application, then the display name is selected in the following order if available:
Embedded data specification.
An extension of the element.
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.
Note: In case the element is a property and the property has a semantic definition (semanticId) conformant to IEC61360 the idShort is typically identical to the short name in English.
Timestamp in UTC, when the last event was received (input direction) or sent (output direction).
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
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.
Note: For different message infrastructure, e.g., OPC UA or MQTT or AMQP, this proprietary specification could be standardized by having respective Submodels.
Information for the outer message infrastructure for scheduling the event to the respective communication channel.
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.
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.
Additional qualification of a qualifiable element.
Constraint AASd-021:
Every qualifiable can only have one qualifier with the same
type.
Identifier of the semantic definition of the element. It is called semantic ID of the element or also main semantic ID of the element.
Note: It is recommended to use a global reference.
State of event.
Can be { On, Off }.
Identifier of a supplemental semantic definition of the element. It is called supplemental semantic ID of the element.
Note: It is recommended to use a global reference.
Dispatch visitor on this instance.
to visit this instance
Dispatch visitor with context on this instance.
type of the context
to visit this instance
to be passed along to the dispatched visitor method
kind if set or the default value otherwise.
Yield from description if it is set, or yield nothing.
Yield from displayName if it is set, or yield nothing.
Yield from embeddedDataSpecifications if it is set, or yield nothing.
Yield from extensions if it is set, or yield nothing.
Yield from qualifiers if it is set, or yield nothing.
Yield from supplementalSemanticIds if it is set, or yield nothing.
Dispatch the transformer on this instance.
transformation of this instance
T - type of the transformation result
to transform this instance
Dispatch the transformer on this instance in context.
transformation of this instance
T - type of the transformation result
ContextT - type of the transformation context
to transform this instance
to be passed along to the transformer
Generated using TypeDoc
A basic event element.