NodeOPCUA API Documentation
    Preparing search index...

    Interface Namespace

    interface Namespace {
        $emulateVersion103?: boolean;
        addressSpace: IAddressSpace;
        index: number;
        namespaceUri: string;
        publicationDate: Date;
        version: string;
        addAlias(aliasName: string, nodeId: NodeId): void;
        addAnalogDataItem<T, DT extends DataType>(
            options: AddAnalogDataItemOptions,
        ): UAAnalogItemEx<T, DT>;
        addDataItem<T, DT extends DataType>(
            options: AddDataItemOptions,
        ): UADataItem<T, DT>;
        addEnumerationType(options: AddEnumerationTypeOptions): UADataType;
        addEventType(
            options: {
                browseName: QualifiedNameLike;
                isAbstract?: boolean;
                subtypeOf?: string | UAEventType;
            },
        ): UAEventType;
        addFolder(
            parentFolder: NodeIdLike | UAObject<UAObjectEvents>,
            options: string | AddBaseNodeOptions,
        ): UAObject;
        addMethod(
            parent: UAObjectType | UAObject<UAObjectEvents>,
            options: AddMethodOptions,
        ): UAMethod;
        addMultiStateDiscrete<T, DT extends DataType>(
            options: AddMultiStateDiscreteOptions,
        ): UAMultiStateDiscreteEx<T, DT>;
        addMultiStateValueDiscrete<T, DT extends DataType>(
            options: AddMultiStateValueDiscreteOptions,
        ): UAMultiStateValueDiscreteEx<T, DT>;
        addObject(options: AddObjectOptions): UAObject;
        addObjectType(options: AddObjectTypeOptions): UAObjectType;
        addReferenceType(options: AddReferenceTypeOptions): UAReferenceType;
        addState(
            component: UAObjectType | UAObject<UAObjectEvents>,
            stateName: QualifiedNameLike,
            stateNumber: number,
            isInitialState?: boolean,
        ): UAState;
        addTransition(
            component: UAObjectType | UAObject<UAObjectEvents>,
            fromState: string,
            toState: string,
            transitionNumber: number,
            browseName?: QualifiedNameLike,
        ): UATransitionEx;
        addTwoStateDiscrete(
            options: AddTwoStateDiscreteOptions,
        ): UATwoStateDiscreteEx;
        addTwoStateVariable(
            options: AddTwoStateVariableOptions,
        ): UATwoStateVariableEx;
        addVariable(options: AddVariableOptions): UAVariable;
        addVariableType(options: AddVariableTypeOptions): UAVariableType;
        addView(options: AddViewOptions): UAView;
        addYArrayItem<DT extends Float | Double>(
            options: AddYArrayItemOptions,
        ): UAYArrayItemEx<DT>;
        constructNodeId(options: ConstructNodeIdOptions): NodeId;
        createDataType(options: CreateDataTypeOptions): UADataType;
        createNode(options: CreateNodeOptions): BaseNode;
        deleteNode(node: NodeId | BaseNode<BaseNodeEvents>): void;
        findDataType(dataType: string): UADataType | null;
        findNode(nodeId: NodeIdLike): BaseNode<BaseNodeEvents> | null;
        findNode2(nodeId: NodeId): BaseNode<BaseNodeEvents> | null;
        findObjectType(objectType: string): UAObjectType | null;
        findReferenceType(referenceType: string): UAReferenceType | null;
        findReferenceTypeFromInverseName(
            referenceType: string,
        ): UAReferenceType | null;
        findVariableType(variableType: string): UAVariableType | null;
        getDefaultAccessRestrictions(): AccessRestrictionsFlag;
        getDefaultRolePermissions(): RolePermissionType[] | null;
        getRequiredModels(): RequiredModel[] | undefined;
        instantiateAcknowledgeableCondition(
            conditionTypeId: string | NodeId | UAEventType,
            options: InstantiateAlarmConditionOptions,
            data?: Record<string, VariantOptions>,
        ): UAAcknowledgeableConditionEx;
        instantiateAlarmCondition(
            alarmConditionTypeId: string | NodeId | UAEventType,
            options: InstantiateAlarmConditionOptions,
            data?: Record<string, VariantOptions>,
        ): UAAlarmConditionEx;
        instantiateCondition(
            conditionTypeId: string | NodeId | UAEventType,
            options: InstantiateConditionOptions,
            data?: Record<string, VariantOptions>,
        ): UAConditionEx;
        instantiateDiscreteAlarm(
            discreteAlarmType: string | NodeId | UAEventType,
            options: InstantiateAlarmConditionOptions,
            data?: Record<string, VariantOptions>,
        ): UADiscreteAlarmEx;
        instantiateExclusiveDeviationAlarm(
            options: InstantiateExclusiveDeviationAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UAExclusiveDeviationAlarmEx;
        instantiateExclusiveLimitAlarm(
            exclusiveLimitAlarmTypeId: string | NodeId | UAEventType,
            options: InstantiateExclusiveLimitAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UAExclusiveLimitAlarmEx;
        instantiateLimitAlarm(
            limitAlarmTypeId: string | NodeId | UAEventType,
            options: InstantiateLimitAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UALimitAlarmEx;
        instantiateNonExclusiveDeviationAlarm(
            options: InstantiateNonExclusiveDeviationAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UANonExclusiveDeviationAlarmEx;
        instantiateNonExclusiveLimitAlarm(
            nonExclusiveLimitAlarmTypeId: string | NodeId | UAEventType,
            options: InstantiateNonExclusiveLimitAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UANonExclusiveLimitAlarmEx;
        instantiateOffNormalAlarm(
            options: InstantiateOffNormalAlarmOptions,
            data?: Record<string, VariantOptions>,
        ): UAOffNormalAlarmEx;
        setDefaultAccessRestrictions(
            accessRestrictions: AccessRestrictionsFlag,
        ): void;
        setDefaultRolePermissions(
            rolePermissions: RolePermissionTypeOptions[] | null,
        ): void;
        toNodeset2XML(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $emulateVersion103? addressSpace index namespaceUri publicationDate version

    Methods

    addAlias addAnalogDataItem addDataItem addEnumerationType addEventType addFolder addMethod addMultiStateDiscrete addMultiStateValueDiscrete addObject addObjectType addReferenceType addState addTransition addTwoStateDiscrete addTwoStateVariable addVariable addVariableType addView addYArrayItem constructNodeId createDataType createNode deleteNode findDataType findNode findNode2 findObjectType findReferenceType findReferenceTypeFromInverseName findVariableType getDefaultAccessRestrictions getDefaultRolePermissions getRequiredModels instantiateAcknowledgeableCondition instantiateAlarmCondition instantiateCondition instantiateDiscreteAlarm instantiateExclusiveDeviationAlarm instantiateExclusiveLimitAlarm instantiateLimitAlarm instantiateNonExclusiveDeviationAlarm instantiateNonExclusiveLimitAlarm instantiateOffNormalAlarm setDefaultAccessRestrictions setDefaultRolePermissions toNodeset2XML

    Properties

    $emulateVersion103?: boolean
    addressSpace: IAddressSpace
    index: number
    namespaceUri: string
    publicationDate: Date
    version: string

    Methods

    • Parameters

      • aliasName: string
      • nodeId: NodeId

      Returns void

    • add a new event type to the address space

      Parameters

      Returns UAEventType

      const evtType = namespace.addEventType({
               browseName: "MyAuditEventType",
               subtypeOf:  "AuditEventType"
           });
           const myConditionType = namespace.addEventType({
               browseName: "MyConditionType",
               subtypeOf:  "ConditionType",
               isAbstract: false
           });

    • Parameters

      • options: ConstructNodeIdOptions

      Returns NodeId

    • Parameters

      • dataType: string

      Returns UADataType | null

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addAliasaddAnalogDataItemaddDataItemaddEnumerationTypeaddEventTypeaddFolderaddMethodaddMultiStateDiscreteaddMultiStateValueDiscreteaddObjectaddObjectTypeaddReferenceTypeaddStateaddTransitionaddTwoStateDiscreteaddTwoStateVariableaddVariableaddVariableTypeaddViewaddYArrayItemconstructNodeIdcreateDataTypecreateNodedeleteNodefindDataTypefindNodefindNode2findObjectTypefindReferenceTypefindReferenceTypeFromInverseNamefindVariableTypegetDefaultAccessRestrictionsgetDefaultRolePermissionsgetRequiredModelsinstantiateAcknowledgeableConditioninstantiateAlarmConditioninstantiateConditioninstantiateDiscreteAlarminstantiateExclusiveDeviationAlarminstantiateExclusiveLimitAlarminstantiateLimitAlarminstantiateNonExclusiveDeviationAlarminstantiateNonExclusiveLimitAlarminstantiateOffNormalAlarmsetDefaultAccessRestrictionssetDefaultRolePermissionstoNodeset2XML