Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UANamespaceMetadataType

Hierarchy

  • UAObject
    • UANamespaceMetadataType

Properties

_namespaceUri

_namespaceUri: UAVariableT<string, String>

The NamespaceUri Property contains the namespace represented by an instance of the MetaDataType.

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

Optional defaultAccessRestrictions

defaultAccessRestrictions: UAVariableT<number, UInt16>

The DefaultAccessRestrictions Property is present if a Server supports AccessRestrictions for the Namespace and provides the defaults. A Node in the Namespace overrides this default by adding a AccessRestrictions Attribute to the Node. If a Server implements a vendor-specific AccessRestriction model for a Namespace, it does not add the DefaultAccessRestrictions Property to the NamespaceMetadata Object.

Optional defaultRolePermissions

defaultRolePermissions: UAVariableT<RolePermissionType[], ExtensionObject>

The DefaultRolePermissions Property provides the default permissions if a Server supports RolePermissions for the Namespace. A Node in the Namespace overrides this default by adding a RolePermissions Attribute to the Node. If a Server implements a vendor-specific RolePermissions model for a Namespace, it does not add the DefaultRolePermissions Property to the NamespaceMetadata Object.

Optional defaultUserRolePermissions

defaultUserRolePermissions: UAVariableT<RolePermissionType[], ExtensionObject>

The DefaultUserRolePermissions Property provides the default user permissions if a Server supports UserRolePermissions for the Namespace. A Node in the Namespace overrides this default by adding a UserRolePermissions Attribute to the Node. If a Server implements a vendor-specific UserRolePermissions model for a Namespace, it does not add the DefaultUserRolePermissions Property to the NamespaceMetadata Object.

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly hasMethods

hasMethods: boolean

isNamespaceSubset

isNamespaceSubset: UAVariableT<boolean, Boolean>

The IsNamespaceSubset Property defines whether all Nodes of the namespace are accessible in the Server or only a subset.It is set to FALSE if the full namespace is provided and TRUE if not.If the completeness is unknown then this Property shall be set to TRUE.

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Optional namespaceFile

namespaceFile: UAAddressSpaceFileType

The Object NamespaceFile contains all Nodes and References of the namespace in an XML file where the Information Model XML Schema is defined in Part 6. The XML file is provided through an AddressSpaceFileType Object.

Readonly namespaceIndex

namespaceIndex: number

namespacePublicationDate

namespacePublicationDate: UAVariableT<Date, DateTime>

Readonly namespaceUri

namespaceUri: string

namespaceVersion

namespaceVersion: UAVariableT<string, String>

The NamespaceVersion Property provides version information for the namespace.It is intended for display purposes and shall not be used to programmatically identify the latest version.If there is no formal version defined for the namespace this Property shall be set to a null String.

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: function

Type declaration

    • (this: BaseNode): Promise<void>
    • Parameters

      • this: BaseNode

      Returns Promise<void>

parent

parent: BaseNode | null

Optional Readonly parentNodeId

parentNodeId: NodeId

staticNodeIdTypes

staticNodeIdTypes: UAVariableT<IdType[], ExtensionObject>

The StaticNodeIdTypes Property provides a list of IdTypes used for static Nodes.All Nodes in the AddressSpace of the namespace using one of the IdTypes in the array shall be static Nodes.

staticNumericNodeIdRange

staticNumericNodeIdRange: UAVariableT<NumericRange[], ExtensionObject>

The StaticNumericNodeIdRange Property provides a list of NumericRanges used for numeric NodeIds of static Nodes.If the StaticNodeIdTypes Property contains an entry for numeric NodeIds then this Property is ignored.

staticStringNodeIdPattern

staticStringNodeIdPattern: UAVariableT<string, String>

The StaticStringNodeIdPattern Property provides a regular expression as defined for the Like Operator defined in Part 4 to filter for string NodeIds of static Nodes.If the StaticNodeIdTypes Property contains an entry for string NodeIds then this Property is ignored.

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addReference

  • addReference(options: AddReferenceOpts): void
  • Parameters

    • options: AddReferenceOpts

    Returns void

allReferences

  • allReferences(): Reference[]
  • Returns Reference[]

browseNode

  • browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]
  • browse the node to extract information requested in browseDescription

    method

    browseNode

    Parameters

    • browseDescription: BrowseDescriptionOptions
    • Optional session: SessionContext

    Returns ReferenceDescription[]

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject
  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAObject

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference | null
  • Parameters

    • strReference: string
    • Optional isForward: boolean

    Returns UAReference | null

findReferences

  • findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]
  • Parameters

    • referenceType: string | NodeId | UAReferenceType
    • Optional isForward: boolean

    Returns UAReference[]

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]
  • Parameters

    • strReference: string
    • isForward: boolean

    Returns BaseNode[]

findReferencesEx

  • findReferencesEx(strReference: string, browseDirection?: BrowseDirection): UAReference[]
  • Parameters

    Returns UAReference[]

findReferencesExAsObject

  • findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

fullName

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

    Returns string

getAggregates

  • getAggregates(): BaseNode[]
  • Returns BaseNode[]

getChildByName

  • getChildByName(browseName: string | QualifiedName): BaseNode | null
  • Parameters

    • browseName: string | QualifiedName

    Returns BaseNode | null

getComponentByName

  • getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable | null
  • Parameters

    Returns UAObject | UAVariable | null

getComponents

  • getComponents(): BaseNode[]
  • Returns BaseNode[]

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]
  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]
  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode | null

getMaxListeners

  • getMaxListeners(): number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethod | null
  • Parameters

    • nodeId: NodeId

    Returns UAMethod | null

getMethodByName

  • getMethodByName(methodName: string): UAMethod | null
  • Parameters

    • methodName: string

    Returns UAMethod | null

getMethods

  • getMethods(): UAMethod[]
  • Returns UAMethod[]

getNotifiers

  • getNotifiers(): BaseNode[]
  • Returns BaseNode[]

getProperties

  • getProperties(): BaseNode[]
  • Returns BaseNode[]

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAVariable | null

install_extra_properties

  • install_extra_properties(): void

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(eventName: "event", eventHandler: function): this
  • Parameters

    • eventName: "event"
    • eventHandler: function
        • (eventData: IEventData): void
        • Parameters

          • eventData: IEventData

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

propagate_back_references

  • propagate_back_references(): void
  • this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

    Returns void

raiseEvent

  • raiseEvent(eventType: EventTypeLike, eventData: RaiseEventData): void
  • Parameters

    Returns void

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

  • readAttribute(context: SessionContext | null, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike | null): DataValue
  • Parameters

    Returns DataValue

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeReference

  • removeReference(referenceOpts: AddReferenceOpts): void
  • Parameters

    • referenceOpts: AddReferenceOpts

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: function): void
  • Parameters

    • context: SessionContext
    • writeValue: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Generated using TypeDoc