Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UAHistoryServerCapabilities

Hierarchy

  • UAObject
    • UAHistoryServerCapabilities

Properties

accessHistoryDataCapability

accessHistoryDataCapability: UAVariableT<boolean, 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, 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.

Readonly 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 compatibility, 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.

Readonly browseName

browseName: QualifiedName

deleteAtTimeCapability

deleteAtTimeCapability: UAVariableT<boolean, 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, 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, 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.

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly hasMethods

hasMethods: boolean

insertAnnotationsCapability

insertAnnotationsCapability: UAVariableT<boolean, 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, 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, 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, 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, UInt32>

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

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: 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

replaceDataCapability

replaceDataCapability: UAVariableT<boolean, 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, 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, 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, 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, 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.

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

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

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

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

    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

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

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

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