Interface IVariableHistorian

interface IVariableHistorian {
    extractDataValues(historyReadRawModifiedDetails: ReadRawModifiedDetails, maxNumberToExtract: number, isReversed: boolean, reverseDataValue: boolean, callback: ((err: null | Error, dataValue?: DataValue[]) => void)): void;
    push(newDataValue: DataValue): Promise<void>;
}

Implemented by

Methods

extractDataValues push

Methods

extractDataValues

  • extractDataValues(historyReadRawModifiedDetails, maxNumberToExtract, isReversed, reverseDataValue, callback): void

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

    Parameters

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

        • Parameters

          • err: null | Error
          • OptionaldataValue: DataValue[]

          Returns void

    Returns void

push

  • push(newDataValue): Promise<void>

  • 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

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods