Class BasicEventElement

A basic event element.

Inheritance
System.Object
BasicEventElement
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_RC02
Assembly: AasCore.Aas3_0_RC02.dll
Syntax
public class BasicEventElement : IBasicEventElement, IEventElement, ISubmodelElement, IReferable, IHasExtensions, IHasKind, IHasSemantics, IQualifiable, IHasDataSpecification, IClass

Constructors

| Improve this Doc View Source

BasicEventElement(IReference, Direction, StateOfEvent, List<IExtension>, String, String, List<ILangString>, List<ILangString>, String, Nullable<ModelingKind>, IReference, List<IReference>, List<IQualifier>, List<IEmbeddedDataSpecification>, String, IReference, String, String, String)

Declaration
public BasicEventElement(IReference observed, Direction direction, StateOfEvent state, List<IExtension> extensions = null, string category = null, string idShort = null, List<ILangString> displayName = null, List<ILangString> description = null, string checksum = null, ModelingKind? kind = null, IReference semanticId = null, List<IReference> supplementalSemanticIds = null, List<IQualifier> qualifiers = null, List<IEmbeddedDataSpecification> embeddedDataSpecifications = null, string messageTopic = null, IReference messageBroker = null, string lastUpdate = null, string minInterval = null, string maxInterval = null)
Parameters
Type Name Description
IReference observed
Direction direction
StateOfEvent state
System.Collections.Generic.List<IExtension> extensions
System.String category
System.String idShort
System.Collections.Generic.List<ILangString> displayName
System.Collections.Generic.List<ILangString> description
System.String checksum
System.Nullable<ModelingKind> kind
IReference semanticId
System.Collections.Generic.List<IReference> supplementalSemanticIds
System.Collections.Generic.List<IQualifier> qualifiers
System.Collections.Generic.List<IEmbeddedDataSpecification> embeddedDataSpecifications
System.String messageTopic
IReference messageBroker
System.String lastUpdate
System.String minInterval
System.String maxInterval

Properties

| Improve this Doc View Source

Category

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.

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

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.

| Improve this Doc View Source

Checksum

Checksum to be used to determine if an Referable (including its aggregated child elements) has changed.

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

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

| Improve this Doc View Source

Description

Description or comments on the element.

Declaration
public List<ILangString> Description { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ILangString>
Remarks

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.

| Improve this Doc View Source

Direction

Direction of event.

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

Can be { Input, Output }.

| Improve this Doc View Source

DisplayName

Display name. Can be provided in several languages.

Declaration
public List<ILangString> DisplayName { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ILangString>
Remarks

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:

  • the preferred name in the requested language of the concept description defining the semantics of the element
  • If there is a default language list defined in the application, then the corresponding preferred name in the language is chosen according to this order.
  • the English preferred name of the concept description defining the semantics of the element
  • the short name of the concept description
  • the IdShort of the element
| Improve this Doc View Source

EmbeddedDataSpecifications

Embedded data specification.

Declaration
public List<IEmbeddedDataSpecification> EmbeddedDataSpecifications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IEmbeddedDataSpecification>
| Improve this Doc View Source

Extensions

An extension of the element.

Declaration
public List<IExtension> Extensions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IExtension>
| Improve this Doc View Source

IdShort

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.

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

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.

| Improve this Doc View Source

Kind

Kind of the element: either type or instance.

Declaration
public ModelingKind? Kind { get; set; }
Property Value
Type Description
System.Nullable<ModelingKind>
Remarks

Default: Instance

| Improve this Doc View Source

LastUpdate

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

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

MaxInterval

For input direction: not applicable.

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

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

| Improve this Doc View Source

MessageBroker

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.

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

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

| Improve this Doc View Source

MessageTopic

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

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

MinInterval

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

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

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.

| Improve this Doc View Source

Observed

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

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

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

| Improve this Doc View Source

Qualifiers

Additional qualification of a qualifiable element.

Declaration
public List<IQualifier> Qualifiers { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IQualifier>
Remarks

Constraints:

  • Constraint AASd-021: Every qualifiable can only have one qualifier with the same Type.
| Improve this Doc View Source

SemanticId

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

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

It is recommended to use a global reference.

| Improve this Doc View Source

State

State of event.

Declaration
public StateOfEvent State { get; set; }
Property Value
Type Description
StateOfEvent
Remarks

Can be { On, Off }.

| Improve this Doc View Source

SupplementalSemanticIds

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

Declaration
public List<IReference> SupplementalSemanticIds { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IReference>
Remarks

It is recommended to use a global reference.

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

KindOrDefault()

Return the Kind or the default value if it has not been set.

Declaration
public ModelingKind KindOrDefault()
Returns
Type Description
ModelingKind
| Improve this Doc View Source

OverDescriptionOrEmpty()

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

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

OverDisplayNameOrEmpty()

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

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

OverEmbeddedDataSpecificationsOrEmpty()

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

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

OverExtensionsOrEmpty()

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

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

OverQualifiersOrEmpty()

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

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

OverSupplementalSemanticIdsOrEmpty()

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

Declaration
public IEnumerable<IReference> OverSupplementalSemanticIdsOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<IReference>
| 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