Search Results for

    Show / Hide Table of Contents

    Interface IBasicEventElement

    A basic event element.

    Inherited Members
    IReferable.Category
    IReferable.IdShort
    IReferable.DisplayName
    IReferable.Description
    IReferable.OverDisplayNameOrEmpty()
    IReferable.OverDescriptionOrEmpty()
    IHasExtensions.Extensions
    IHasExtensions.OverExtensionsOrEmpty()
    IHasSemantics.SemanticId
    IHasSemantics.SupplementalSemanticIds
    IHasSemantics.OverSupplementalSemanticIdsOrEmpty()
    IQualifiable.Qualifiers
    IQualifiable.OverQualifiersOrEmpty()
    IHasDataSpecification.EmbeddedDataSpecifications
    IHasDataSpecification.OverEmbeddedDataSpecificationsOrEmpty()
    IClass.DescendOnce()
    IClass.Descend()
    IClass.Accept(Visitation.IVisitor)
    IClass.Accept<TContext>(Visitation.IVisitorWithContext<TContext>, TContext)
    IClass.Transform<T>(Visitation.ITransformer<T>)
    IClass.Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T>, TContext)
    Namespace: AasCore.Aas3_0
    Assembly: AasCore.Aas3_0.dll
    Syntax
    public interface IBasicEventElement : IEventElement, ISubmodelElement, IReferable, IHasExtensions, IHasSemantics, IQualifiable, IHasDataSpecification, IClass
    Remarks

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

    Properties

    | Improve this Doc View Source

    Direction

    Direction of event.

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

    Can be { Input, Output }.

    | Improve this Doc View Source

    LastUpdate

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

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

    MaxInterval

    For input direction: not applicable.

    Declaration
    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
    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
    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
    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
    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

    State

    State of event.

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

    Can be { On, Off }.

    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX