From OpenSCADAWiki
Jump to: navigation, search

Функції об'єкту архіву (SYS.Archive["va_Archive"]):

  • ElTp cfg( string nm ) — отримує значення конфігураційного поля nm об'єкту.
  • bool cfgSet( string nm, ElTp val ) [доступ до відповідної підсистеми] — встановлює конфігураційне поля nm об'єкту у значення val.
  • bool status( ) — статус архіву "Виконання".
  • int end( string arch = "" ) — час закінчення даних архіву для архіватору arch, у мікросекундах.
  • int begin( string arch = "" ) — час початку даних архіву для архіватору arch, у мікросекундах.
  • int period( string arch = "" ) — період даних архіву для архіватору arch, у мікросекундах.
  • TArrayObj archivatorList( ) — перелік архіваторів, які використовують цей архів як джерело.
  • VarType getVal( int tm, bool up_ord = false, string arch = "" ) — отримує значення з архіву на час tm, підтягненням догори up_ord та архіватору arch:
    • tm — час запитаного значення, у мікросекундах, встановити у 0 для "end()"; цей атрибут є також виходом, відтак реальний час отриманого значення поміщається сюди, якщо це змінна;
    • up_ord — підтягувати час запитаного значення догори ґратки;
    • arch — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
  • bool setVal( int tm, VarType vl, string arch = "" ) [доступ до підсистеми Архіви-Історія] — встановлює значення vl у архів на час tm та архіватор arch:
    • tm — час встановленого значення, у мікросекундах;
    • vl — значення;
    • arch — архіватор встановлення, встановити у порожній рядок для всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
  • Array getVals( int begTm, int endTm, int period, string arch = "" ) — отримує архів/історію значень з begTm та до endTm для архіватору arch:
    • begTm — час початку запитаного діапазону даних, у мікросекундах, буде змінено у реальний початок даних;
    • endTm — час закінчення запитаного діапазону даних, у мікросекундах;
    • period — період даних, у мікросекундах, має бути обов'язково визначене та буде використане максимальне значення для цього архіву, буде змінено у періодичність реальних даних;
    • arch — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
  • bool setVals( Array buf, int tm, int period, string arch = "" ) [доступ до підсистеми Архіви-Історія] — встановлює значення архіву/історії buf у архів від часу початку tm, для періоду значень period та архіватору arch.
    • buf — масив значень до встановлення;
    • tm — час початку встановлюваного діапазону даних, у мікросекундах;
    • period — період встановлюваних даних, у мікросекундах, має бути обов'язково визначене та буде використане максимальне значення для цього архіву, буде змінено у періодичність реальних даних;
    • arch — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.