Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UAHistoryServerCapabilities

Hierarchy

Index

Properties

accessHistoryDataCapability

accessHistoryDataCapability: UAVariableT<boolean>

The AccessHistoryDataCapability Variable defines if the Server supports access to historical data values. A value of True indicates the Server supports access to the history for HistoricalNodes, a value of False indicates the Server does not support access to the history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the Server to be a valid OPC UA Server supporting Historical Access.

accessHistoryEventsCapability

accessHistoryEventsCapability: UAVariableT<boolean>

The AccessHistoryEventCapability Variable defines if the server supports access to historical Events. A value of True indicates the server supports access to the history of Events, a value of False indicates the Server does not support access to the history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the Server to be a valid OPC UA Server supporting Historical Access.

addressSpace

addressSpace: AddressSpace

Optional aggregateConfiguration

aggregateConfiguration: UAObject

AggregateConfiguration Object represents the browse entry point for information on how the Server treats Aggregate specific functionality such as handling Uncertain data. This Object is listed as optional for backward compatability, but it is required to be present if Aggregates are supported (via Profiles)

aggregateFunctions

aggregateFunctions: Folder

AggregateFunctions is an entry point to browse to all Aggregate capabilities supported by the Server for Historical Access. All HistoryAggregates supported by the Server should be able to be browsed starting from this Object. Aggregates are defined in Part 13. If the Server does not support Aggregates the Folder is left empty.

browseName

browseName: QualifiedName

deleteAtTimeCapability

deleteAtTimeCapability: UAVariableT<boolean>

The DeleteAtTimeCapability Variable indicates support for the delete at time capability. A value of True indicates the Server supports the capability to delete a data value at a specified time. The default value is False.

deleteEventCapability

deleteEventCapability: UAVariableT<boolean>

The DeleteEventCapability Variable indicates support for the deletion of Events capability. A value of True indicates the Server supports the capability to delete Events in history. The default value is False

deleteRawCapability

deleteRawCapability: UAVariableT<boolean>

The DeleteRawCapability Variable indicates support for the delete raw values capability. A value of True indicates the Server supports the capability to delete raw data values in history. The default value is False.

description

description: LocalizedText

displayName

displayName: LocalizedText[]

hasMethods

hasMethods: boolean

insertAnnotationsCapability

insertAnnotationsCapability: UAVariableT<boolean>

The InsertAnnotationCapability Variable indicates support for Annotations. A value of True indicates the Server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

insertDataCapability

insertDataCapability: UAVariableT<boolean>

The InsertDataCapability Variable indicates support for the Insert capability. A value of True indicates the Server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

insertEventCapability

insertEventCapability: UAVariableT<boolean>

The InsertEventCapability Variable indicates support for the Insert capability. A value of True indicates the Server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

maxReturnDataValues

maxReturnDataValues: UAVariableT<UInt32>

The MaxReturnDataValues Variable defines the maximum number of values that can be returned by the Server for each HistoricalNode accessed during a request. A value of 0 indicates that the Server forces no limit on the number of values it can return. It is valid for a Server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the Server does not impose any restrictions, the underlying system may impose a limit that the Server is not aware of. The default value is 0.

maxReturnEventValues

maxReturnEventValues: UAVariableT<UInt32>

Similarily, the MaxReturnEventValues specifies the maximum number of Events that a Server can return for a HistoricalEventNode.

Optional modellingRule

modellingRule: ModellingRuleType

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Object

nodeId

nodeId: NodeId

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

replaceDataCapability

replaceDataCapability: UAVariableT<boolean>

The ReplaceDataCapability Variable indicates support for the Replace capability. A value of True indicates the Server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

replaceEventCapability

replaceEventCapability: UAVariableT<boolean>

The ReplaceEventCapability Variable indicates support for the Replace capability. A value of True indicates the Server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

Optional serverTimestampSupported

serverTimestampSupported: UAVariableT<boolean>

The ServerTimestampSupported Variable indicates support for the ServerTimestamp capability. A value of True indicates the Server supports ServerTimestamps in addition to SourceTimestamp. The default is False. This property is optional but it is expected all new Servers include this property.

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

updateDataCapability

updateDataCapability: UAVariableT<boolean>

The UpdateDataCapability Variable indicates support for the Update capability. A value of True indicates the Server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

updateEventCapability

updateEventCapability: UAVariableT<boolean>

The UpdateEventCapability Variable indicates support for the Update capability. A value of True indicates the Server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

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