NodeOPCUA API Documentation
    Preparing search index...

    Interface UATransitionEventType

    The TransitionEventType is a subtype of the BaseEventType. It can be used to generate an Event identifying that a Transition of a StateMachine was triggered.

    The TransitionEventType inherits the Properties of the BaseEventType.

    The inherited Property SourceNode shall be filled with the NodeId of the StateMachine instance where the Transition occurs. If the Transition occurs in a SubStateMachine, then the NodeId of the SubStateMachine has to be used. If the Transition occurs between a StateMachine and a SubStateMachine, then the NodeId of the StateMachine has to be used, independent of the direction of the Transition.

    interface UATransitionEventType {
        browseName: QualifiedName;
        conditionClassId?: UAProperty<NodeId, NodeId>;
        conditionClassName?: UAProperty<LocalizedText, LocalizedText>;
        conditionSubClassId?: UAProperty<NodeId[], NodeId>;
        conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>;
        eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        eventType: UAProperty<NodeId, NodeId>;
        fromState: UAStateVariable<LocalizedText>;
        hasMethods: boolean;
        isAbstract: boolean;
        localTime?: UAProperty<DTTimeZone, ExtensionObject>;
        message: UAProperty<LocalizedText, LocalizedText>;
        nodeClass: ObjectType;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        receiveTime: UAProperty<Date, DateTime>;
        severity: UAProperty<number, UInt16>;
        sourceName: UAProperty<UAString, String>;
        sourceNode: UAProperty<NodeId, NodeId>;
        subtypeOf: NodeId | null;
        subtypeOfObj: UAObjectType | null;
        time: UAProperty<Date, DateTime>;
        toState: UAStateVariable<LocalizedText>;
        transition: UATransitionVariable<LocalizedText>;
        get accessRestrictions(): AccessRestrictionsFlag | undefined;
        get addressSpace(): IAddressSpace;
        get description(): LocalizedText;
        get displayName(): LocalizedText[];
        get modellingRule(): ModellingRuleType | undefined;
        get namespace(): INamespace;
        get namespaceIndex(): number;
        get namespaceUri(): string;
        get parentNodeId(): NodeId | undefined;
        get rolePermissions(): RolePermissionType[] | undefined;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        emit<K extends keyof BaseNodeEvents>(
            event: K,
            ...args: Parameters<BaseNodeEvents[K]>,
        ): boolean;
        findReference(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference | null;
        findReferences(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference[];
        findReferencesAsObject(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): BaseNode<BaseNodeEvents>[];
        findReferencesEx(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): UAReference[];
        findReferencesExAsObject(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): BaseNode<BaseNodeEvents>[];
        fullName(): string;
        getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
        getAggregates(): BaseNode<BaseNodeEvents>[];
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getComponentByName(
            componentName: QualifiedNameOptions,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponentByName(
            componentName: string,
            namespaceIndex?: number,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponents(): BaseNode<BaseNodeEvents>[];
        getDisplayName(locale?: string): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameLike,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethods(): UAMethod<UAMethodEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getNotifiers(): BaseNode<BaseNodeEvents>[];
        getProperties(): BaseNode<BaseNodeEvents>[];
        getPropertyByName(
            propertyName: QualifiedNameOptions,
        ): UAVariable<UAVariableEvents> | null;
        getPropertyByName(
            propertyName: string,
            namespaceIndex?: number,
        ): UAVariable<UAVariableEvents> | null;
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        install_extra_properties(): void;
        instantiate(options: InstantiateObjectOptions): UAObject;
        isDisposed(): boolean;
        isSubtypeOf(referenceType: NodeIdLike | UAObjectType): boolean;
        isSupertypeOf(referenceType: NodeIdLike | UAObjectType): boolean;
        listenerCount<K extends keyof BaseNodeEvents>(event: K): number;
        off<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        on<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        once<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): this;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof BaseNodeEvents>(
            event: K,
            listener: BaseNodeEvents[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setMaxListeners(n: number): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    browseName conditionClassId? conditionClassName? conditionSubClassId? conditionSubClassName? eventId eventType fromState hasMethods isAbstract localTime? message nodeClass nodeId onFirstBrowseAction? receiveTime severity sourceName sourceNode subtypeOf subtypeOfObj time toState transition

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parentNodeId rolePermissions

    Methods

    addReference allReferences browseNode browseNodeByTargetName emit findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getChildByName getComponentByName getComponents getDisplayName getEventSourceOfs getEventSources getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions install_extra_properties instantiate isDisposed isSubtypeOf isSupertypeOf listenerCount off on once readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setMaxListeners setRolePermissions writeAttribute

    Properties

    browseName: QualifiedName
    conditionClassId?: UAProperty<NodeId, NodeId>
    conditionClassName?: UAProperty<LocalizedText, LocalizedText>
    conditionSubClassId?: UAProperty<NodeId[], NodeId>
    conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>
    eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    eventType: UAProperty<NodeId, NodeId>
    fromState: UAStateVariable<LocalizedText>
    hasMethods: boolean
    isAbstract: boolean
    localTime?: UAProperty<DTTimeZone, ExtensionObject>
    message: UAProperty<LocalizedText, LocalizedText>
    nodeClass: ObjectType
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    receiveTime: UAProperty<Date, DateTime>
    severity: UAProperty<number, UInt16>
    sourceName: UAProperty<UAString, String>
    sourceNode: UAProperty<NodeId, NodeId>
    subtypeOf: NodeId | null
    subtypeOfObj: UAObjectType | null
    time: UAProperty<Date, DateTime>
    toState: UAStateVariable<LocalizedText>
    transition: UATransitionVariable<LocalizedText>

    Accessors

    • get namespaceIndex(): number

      Returns number

    • get namespaceUri(): string

      Returns string

    • get parentNodeId(): NodeId | undefined

      Returns NodeId | undefined

    Methods

    • find the the references that are strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns UAReference | null

    • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns BaseNode<BaseNodeEvents>[]

    • return a complete name of this object by pre-pending name of its parent(s) to its own name

      Returns string

    • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

      Parameters

      • inherited: boolean

      Returns AccessRestrictionsFlag

    • Parameters

      • Optionallocale: string

        the locale of the text to return (e.g. en-EN)

      Returns string

    • Returns boolean

    • Returns void

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods