Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VariableHistorian

Hierarchy

  • VariableHistorian

Implements

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly node

node: UAVariable

Methods

extractDataValues

  • extractDataValues(historyReadRawModifiedDetails: any, maxNumberToExtract: number, isReversed: boolean, reverseDataValue: boolean, callback: CallbackT<DataValue[]>): void
  • extractDataValues(historyReadRawModifiedDetails: ReadRawModifiedDetails, maxNumberToExtract: number, isReversed: boolean, reverseDataValue: boolean, callback: function): void

  • Parameters

    • historyReadRawModifiedDetails: any
    • maxNumberToExtract: number
    • isReversed: boolean
    • reverseDataValue: boolean
    • callback: CallbackT<DataValue[]>

    Returns void

  • Extract a series of dataValue from the History database for this value

    Parameters

    • historyReadRawModifiedDetails: ReadRawModifiedDetails
    • maxNumberToExtract: number
    • isReversed: boolean
    • reverseDataValue: boolean
    • callback: function
        • (err: Error | null, dataValue?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValue: DataValue[]

          Returns void

    Returns void

push

  • push(newDataValue: DataValue): any
  • push(newDataValue: DataValue): Promise<void>

  • Parameters

    • newDataValue: DataValue

    Returns any

  • push a new value into the history for this variable the method should take a very small amount of time and not directly write to the underlying database

    Parameters

    • newDataValue: DataValue

    Returns Promise<void>

Generated using TypeDoc