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>(options: AddAnalogDataItemOptions): UAAnalogItemEx<T, DT>;
    addDataItem<T, DT>(options: AddDataItemOptions): UADataItem<T, DT>;
    addEnumerationType(options: AddEnumerationTypeOptions): UADataType;
    addEventType(options: {
        browseName: QualifiedNameLike;
        isAbstract?: boolean;
        subtypeOf?: string | UAEventType;
    }): UAEventType;
    addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject;
    addMethod(parent: UAObject | UAObjectType, options: AddMethodOptions): UAMethod;
    addMultiStateDiscrete<T, DT>(options: AddMultiStateDiscreteOptions): UAMultiStateDiscreteEx<T, DT>;
    addMultiStateValueDiscrete<T, DT>(options: AddMultiStateValueDiscreteOptions): UAMultiStateValueDiscreteEx<T, DT>;
    addObject(options: AddObjectOptions): UAObject;
    addObjectType(options: AddObjectTypeOptions): UAObjectType;
    addReferenceType(options: AddReferenceTypeOptions): UAReferenceType;
    addState(component: UAObject | UAObjectType, stateName: QualifiedNameLike, stateNumber: number, isInitialState?: boolean): UAState;
    addTransition(component: UAObject | UAObjectType, 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>(options: AddYArrayItemOptions): UAYArrayItemEx<DT>;
    constructNodeId(options: ConstructNodeIdOptions): NodeId;
    createDataType(options: CreateDataTypeOptions): UADataType;
    createNode(options: any): BaseNode;
    deleteNode(node: NodeId | BaseNode): void;
    findDataType(dataType: string): null | UADataType;
    findNode(nodeId: NodeIdLike): null | BaseNode;
    findNode2(nodeId: NodeId): null | BaseNode;
    findObjectType(objectType: string): null | UAObjectType;
    findReferenceType(referenceType: string): null | UAReferenceType;
    findReferenceTypeFromInverseName(referenceType: string): null | UAReferenceType;
    findVariableType(variableType: string): null | UAVariableType;
    getDefaultAccessRestrictions(): AccessRestrictionsFlag;
    getDefaultRolePermissions(): null | RolePermissionType[];
    getRequiredModels(): undefined | RequiredModel[];
    getStandardsNodeIds(): {
        objectTypeIds: {
            [key: string]: string;
        };
        referenceTypeIds: {
            [key: string]: string;
        };
    };
    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: any, 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: null | RolePermissionTypeOptions[]): void;
    toNodeset2XML(): string;
}

Hierarchy (view full)

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 getStandardsNodeIds instantiateAcknowledgeableCondition instantiateAlarmCondition instantiateCondition instantiateDiscreteAlarm instantiateExclusiveDeviationAlarm instantiateExclusiveLimitAlarm instantiateLimitAlarm instantiateNonExclusiveDeviationAlarm instantiateNonExclusiveLimitAlarm instantiateOffNormalAlarm setDefaultAccessRestrictions setDefaultRolePermissions toNodeset2XML

Properties

Optional$emulateVersion103

$emulateVersion103?: boolean

addressSpace

addressSpace: IAddressSpace

index

index: number

namespaceUri

namespaceUri: string

publicationDate

publicationDate: Date

version

version: string

Methods

addAlias

  • addAlias(aliasName, nodeId): void

  • Parameters

    • aliasName: string
    • nodeId: NodeId

    Returns void

addAnalogDataItem

addDataItem

addEnumerationType

addEventType

  • addEventType(options): UAEventType

  • add a new event type to the address space

    Parameters

    Returns UAEventType

    Example

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

addFolder

addMethod

addMultiStateDiscrete

addMultiStateValueDiscrete

addObject

addObjectType

addReferenceType

addState

  • addState(component, stateName, stateNumber, isInitialState?): UAState

  • Parameters

    Returns UAState

addTransition

  • addTransition(component, fromState, toState, transitionNumber, browseName?): UATransitionEx

  • Parameters

    Returns UATransitionEx

addTwoStateDiscrete

addTwoStateVariable

addVariable

addVariableType

addView

addYArrayItem

constructNodeId

  • constructNodeId(options): NodeId

  • Parameters

    • options: ConstructNodeIdOptions

    Returns NodeId

createDataType

createNode

  • createNode(options): BaseNode

  • Parameters

    • options: any

    Returns BaseNode

deleteNode

  • deleteNode(node): void

  • Parameters

    Returns void

findDataType

  • findDataType(dataType): null | UADataType

  • Parameters

    • dataType: string

    Returns null | UADataType

findNode

findNode2

  • findNode2(nodeId): null | BaseNode

  • Parameters

    Returns null | BaseNode

findObjectType

findReferenceType

findReferenceTypeFromInverseName

findVariableType

getDefaultAccessRestrictions

getDefaultRolePermissions

getRequiredModels

getStandardsNodeIds

  • getStandardsNodeIds(): {
        objectTypeIds: {
            [key: string]: string;
        };
        referenceTypeIds: {
            [key: string]: string;
        };
    }
  • Internal

    Returns {
        objectTypeIds: {
            [key: string]: string;
        };
        referenceTypeIds: {
            [key: string]: string;
        };
    }

    • objectTypeIds: {
          [key: string]: string;
      }
      • [key: string]: string
    • referenceTypeIds: {
          [key: string]: string;
      }
      • [key: string]: string

instantiateAcknowledgeableCondition

instantiateAlarmCondition

instantiateCondition

  • instantiateCondition(conditionTypeId, options, data?): UAConditionEx

  • Parameters

    Returns UAConditionEx

instantiateDiscreteAlarm

instantiateExclusiveDeviationAlarm

  • instantiateExclusiveDeviationAlarm(options, data?): UAExclusiveDeviationAlarmEx

  • Parameters

    • options: InstantiateExclusiveDeviationAlarmOptions
    • Optionaldata: Record<string, VariantOptions>

    Returns UAExclusiveDeviationAlarmEx

instantiateExclusiveLimitAlarm

instantiateLimitAlarm

instantiateNonExclusiveDeviationAlarm

  • instantiateNonExclusiveDeviationAlarm(options, data?): UANonExclusiveDeviationAlarmEx

  • Parameters

    • options: InstantiateNonExclusiveDeviationAlarmOptions
    • Optionaldata: Record<string, VariantOptions>

    Returns UANonExclusiveDeviationAlarmEx

instantiateNonExclusiveLimitAlarm

  • instantiateNonExclusiveLimitAlarm(nonExclusiveLimitAlarmTypeId, options, data?): UANonExclusiveLimitAlarmEx

  • Parameters

    Returns UANonExclusiveLimitAlarmEx

instantiateOffNormalAlarm

  • instantiateOffNormalAlarm(options, data?): UAOffNormalAlarmEx

  • Parameters

    Returns UAOffNormalAlarmEx

setDefaultAccessRestrictions

setDefaultRolePermissions

toNodeset2XML

  • toNodeset2XML(): string

  • Returns string

Settings

Member Visibility

On This Page

Properties
Methods
addAliasaddAnalogDataItemaddDataItemaddEnumerationTypeaddEventTypeaddFolderaddMethodaddMultiStateDiscreteaddMultiStateValueDiscreteaddObjectaddObjectTypeaddReferenceTypeaddStateaddTransitionaddTwoStateDiscreteaddTwoStateVariableaddVariableaddVariableTypeaddViewaddYArrayItemconstructNodeIdcreateDataTypecreateNodedeleteNodefindDataTypefindNodefindNode2findObjectTypefindReferenceTypefindReferenceTypeFromInverseNamefindVariableTypegetDefaultAccessRestrictionsgetDefaultRolePermissionsgetRequiredModelsgetStandardsNodeIdsinstantiateAcknowledgeableConditioninstantiateAlarmConditioninstantiateConditioninstantiateDiscreteAlarminstantiateExclusiveDeviationAlarminstantiateExclusiveLimitAlarminstantiateLimitAlarminstantiateNonExclusiveDeviationAlarminstantiateNonExclusiveLimitAlarminstantiateOffNormalAlarmsetDefaultAccessRestrictionssetDefaultRolePermissionstoNodeset2XML