Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UAServerCapabilities

Hierarchy

Index

Properties

addressSpace

addressSpace: AddressSpace

aggregateFunctions

aggregateFunctions: Folder

AggregateFunctions is an entry point to browse to all AggregateFunctions supported by the Server. All AggregateFunctions supported by the Server should be able to be browsed starting from this Object. AggregateFunctions are Objects of AggregateFunctionType.

browseName

browseName: QualifiedName

description

description: LocalizedText

displayName

displayName: LocalizedText[]

hasMethods

hasMethods: boolean

Optional historyServerCapabilities

historyServerCapabilities: UAHistoryServerCapabilities

localIdArray

localIdArray: UAVariableT<LocaleId[]>

LocaleIdArray is an array of LocaleIds that are known to be supported by the Server. The Server might not be aware of all LocaleIds that it supports because it may provide access to underlying servers, systems or devices that do not report the LocaleIds that they support.

Optional maxArrayLength

maxArrayLength: UAVariableT<UInt32>

The MaxArrayLength Property indicates the maximum length of a one or multidimensional array supported by Variables of the Server. In a multidimensional array it indicates the overall length. For example, a three-dimensional array of 2x3x10 has the array length of 60. The Server might further restrict the length for individual Variables without notice to the client. Servers may use the Property MaxArrayLength defined in Part 3 on individual DataVariables to specify the size on individual values. The individual Property may have a larger or smaller value than MaxArrayLength.

maxBrowseContinuationPoints

maxBrowseContinuationPoints: UAVariableT<UInt16>

MaxBrowseContinuationPoints is an integer specifying the maximum number of parallel continuation points of the Browse Service that the Server can support per session. The value specifies the maximum the Server can support under normal circumstances, so there is no guarantee the Server can always support the maximum. The client should not open more Browse calls with open continuation points than exposed in this Variable. The value 0 indicates that the Server does not restrict the number of parallel continuation points the client should use

Optional maxByteStringLength

maxByteStringLength: UAVariableT<UInt32>

The MaxByteStringLength Property indicates the maximum number of bytes in a ByteString supported by Variables of the Server. It also specifies the default maximum size of a FileType Object’s read and write buffers. Servers may override this setting by adding the MaxByteStringLength Property defined in Part 3 to an individual DataVariable or FileType Object. If a Server does not impose a maximum number of bytes or is not able to determine the maximum number of bytes this Property shall not be provided.

maxHistoryContinuationPoints

maxHistoryContinuationPoints: UAVariableT<UInt16>

MaxHistoryContinuationPoints is an integer specifying the maximum number of parallel continuation points of the HistoryRead Services that the Server can support per session. The value specifies the maximum the Server can support under normal circumstances, so there is no guarantee the Server can always support the maximum. The client should not open more HistoryRead calls with open continuation points than exposed in this Variable. The value 0 indicates that the Server does not restrict the number of parallel continuation points the client should use.

maxQueryContinuationPoints

maxQueryContinuationPoints: UAVariableT<UInt16>

MaxQueryContinuationPoints is an integer specifying the maximum number of parallel continuation points of the QueryFirst Services that the Server can support per session. The value specifies the maximum the Server can support under normal circumstances, so there is no guarantee the Server can always support the maximum. The client should not open more QueryFirst calls with open continuation points than exposed in this Variable. The value 0 indicates that the Server does not restrict the number of parallel continuation points the client should use.

Optional maxStringLength

maxStringLength: UAVariableT<UInt32>

The MaxStringLength Property indicates the maximum number of bytes in Strings supported by Variables of the Server. Servers may override this setting by adding the MaxStringLength Property defined in Part 3 to an individual DataVariable. If a Server does not impose a maximum number of bytes or is not able to determine the maximum number of bytes this Property shall not be provided.

minSupportedSampleRate

minSupportedSampleRate: UAVariableT<Duration>

MinSupportedSampleRate defines the minimum supported sample rate, including 0, which is supported by the Server.

Optional modellingRule

modellingRule: ModellingRuleType

modellingRules

modellingRules: Folder

ModellingRules is an entry point to browse to all ModellingRules supported by the Server. All ModellingRules supported by the Server should be able to be browsed starting from this Object.

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Object

nodeId

nodeId: NodeId

operationLimits

operationLimits: UAOperationLimits

OperationLimits is an entry point to access information on operation limits of the Server, for example the maximum length of an array in a read Service call.

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

roleSet

roleSet: UARoleSet

The RoleSet Object is used to publish all Roles supported by the Server. The RoleSetType is specified in F.2

serverProfileArray

serverProfileArray: UAVariableT<UAString[]>

ServerProfileArray lists the Profiles that the Server supports. See Part 7 for the definitions of Server Profiles. This list should be limited to the Profiles the Server supports in its current configuration.

softwareCertificates

softwareCertificates: UAVariableT<SignedSoftwareCertificate[]>

SoftwareCertificates is an array of SignedSoftwareCertificates containing all SoftwareCertificates supported by the Server. A SoftwareCertificate identifies capabilities of the Server. It contains the list of Profiles supported by the Server. Profiles are described in Part 7.

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Static defaultMaxListeners

defaultMaxListeners: number

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

allReferences

  • allReferences(): Reference[]

browseNode

  • browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]

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

findReferences

findReferencesAsObject

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

findReferencesEx

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

findReferencesExAsObject

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

fullName

  • fullName(): string

getAggregates

getChildByName

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

getComponentByName

getComponents

getEventSourceOfs

getEventSources

getFolderElementByName

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

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethod | null

getMethodByName

  • getMethodByName(methodName: string): UAMethod | null

getMethods

getNotifiers

getProperties

getPropertyByName

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

install_extra_properties

  • install_extra_properties(): void

listenerCount

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

    • type: 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

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

raiseEvent

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

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

    • Optional event: string | symbol

    Returns 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

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

writeAttribute

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

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc