NodeOPCUA API Documentation
    Preparing search index...

    Interface UAFileTransferStateMachine
    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition FiniteStateMachineType i=2771
    isAbstract true
    interface UAFileTransferStateMachine {
        accessRestrictions: AccessRestrictionsFlag | undefined;
        addressSpace: IAddressSpace;
        applyWrite: UAState;
        applyWriteToError: UATransition;
        applyWriteToIdle: UATransition;
        availableStates?: UABaseDataVariable<NodeId[], NodeId>;
        availableTransitions?: UABaseDataVariable<NodeId[], NodeId>;
        browseName: QualifiedName;
        currentState: UAStateVariable<LocalizedText>;
        description: LocalizedText;
        displayName: LocalizedText[];
        error: UAState;
        errorToIdle: UATransition;
        eventNotifier: EventNotifierFlags;
        hasMethods: boolean;
        idle: UAInitialState;
        idleToApplyWrite: UATransition;
        idleToReadPrepare: UATransition;
        lastTransition?: UATransitionVariable<LocalizedText>;
        modellingRule: ModellingRuleType | undefined;
        namespace: INamespace;
        namespaceIndex: number;
        namespaceUri: string;
        nodeClass: Object;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        parent: BaseNode<BaseNodeEvents> | null;
        parentNodeId: NodeId | undefined;
        readPrepare: UAState;
        readPrepareToError: UATransition;
        readPrepareToReadTransfer: UATransition;
        readTransfer: UAState;
        readTransferToError: UATransition;
        readTransferToIdle: UATransition;
        reset: UAMethod;
        rolePermissions: RolePermissionType[] | undefined;
        typeDefinition: NodeId;
        typeDefinitionObj: UAObjectType;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        clone(
            options: CloneOptions,
            optionalFilter?: CloneFilter,
            extraInfo?: CloneExtraInfo,
        ): UAObject;
        emit<K extends keyof UAObjectEvents>(
            event: K,
            ...args: Parameters<UAObjectEvents[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>[];
        getFolderElementByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getFolderElementByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            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;
        isDisposed(): boolean;
        listenerCount<K extends keyof UAObjectEvents>(event: K): number;
        off<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        on<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        once<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        raiseEvent(
            eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
            eventData: RaiseEventData,
        ): void;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setEventNotifier(eventNotifierFlags: EventNotifierFlags): 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

    accessRestrictions addressSpace applyWrite applyWriteToError applyWriteToIdle availableStates? availableTransitions? browseName currentState description displayName error errorToIdle eventNotifier hasMethods idle idleToApplyWrite idleToReadPrepare lastTransition? modellingRule namespace namespaceIndex namespaceUri nodeClass nodeId onFirstBrowseAction? parent parentNodeId readPrepare readPrepareToError readPrepareToReadTransfer readTransfer readTransferToError readTransferToIdle reset rolePermissions typeDefinition typeDefinitionObj

    Methods

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

    Properties

    accessRestrictions: AccessRestrictionsFlag | undefined
    addressSpace: IAddressSpace
    applyWrite: UAState
    applyWriteToError: UATransition
    applyWriteToIdle: UATransition
    availableStates?: UABaseDataVariable<NodeId[], NodeId>
    availableTransitions?: UABaseDataVariable<NodeId[], NodeId>
    browseName: QualifiedName
    currentState: UAStateVariable<LocalizedText>
    description: LocalizedText
    displayName: LocalizedText[]
    error: UAState
    errorToIdle: UATransition
    eventNotifier: EventNotifierFlags
    hasMethods: boolean
    idle: UAInitialState
    idleToApplyWrite: UATransition
    idleToReadPrepare: UATransition
    lastTransition?: UATransitionVariable<LocalizedText>
    modellingRule: ModellingRuleType | undefined
    namespace: INamespace
    namespaceIndex: number
    namespaceUri: string
    nodeClass: Object
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    parent: BaseNode<BaseNodeEvents> | null
    parentNodeId: NodeId | undefined
    readPrepare: UAState
    readPrepareToError: UATransition
    readPrepareToReadTransfer: UATransition
    readTransfer: UAState
    readTransferToError: UATransition
    readTransferToIdle: UATransition
    reset: UAMethod
    rolePermissions: RolePermissionType[] | undefined
    typeDefinition: NodeId
    typeDefinitionObj: UAObjectType

    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

    • Parameters

      • n: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods