Публичные методы программного управления инспектором данных

В разделе представлены методы программного управления для работы с приложением Инспектор данных.

С помощью программного управления можно:

создавать прогон;
добавлять сигналы в прогон;
просматривать прогоны и сигналы;
экспортировать данные из инспектора данных в рабочую область;
использовать дополнительные методы для работы с инспектором данных: сохранять прогон в файл .ngdat, загружать прогон из файла .ngdat, удалять прогон из инспектора данных, добавлять заметку к прогону.

Методы работают с объектами:

RunID::Int64 — идентификатор прогона в виде целого числа.
RunMeta — объект прогона в виде структуры, которая содержит поля:
```
  time     :: DateTime
  name     :: String
  run_id   :: Int64
  archived :: Bool
```
SignalMeta — объект сигнала в виде структуры, которая содержит поля:
```
  name      :: String
  signal_id :: Int64
  datatype  :: DataType
  dimension :: Tuple
```
SimulationResult — объект результатов симуляции в виде структуры, которая содержит поля:
```
  run_id :: Int64
  dict   :: Dict{String, WorkspaceArray}
```

# engee.di.add_to_run — Function

engee.di.add_to_run(run::Union{Int64, RunMeta}, signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}})::Nothing

Добавляет сигналы signals в прогон run.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.
signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}}: сигналы, заданные в виде WorkspaceArray или Pair{String, DataFrame}.

Примеры

engee.di.add_to_run(12, wa1, wa2)

# для передачи DataFrame, требуется передавать его в Pair, где первый элемент будет именем сигнала.

engee.di.add_to_run(run, "my_signal"=>dataframe, wa2)

# engee.di.create_run — Function

engee.di.create_run(name::String, signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}})::RunMeta

Создает прогон RunMeta с именем name и сигналами signals.

Аргументы

name::String: имя прогона, заданное в виде строки.
signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}}: сигналы, заданные в виде WorkspaceArray или Pair{String, DataFrame}.

Примеры

engee.di.create_run("test_run",wa2)

RunMeta(DateTime("2026-09-23T11:15:12.079"), "test_run", 4, false)

# engee.di.export_signal — Function

engee.di.export_signal(signal_id::Int64)::WorkspaceArray

engee.di.export_signal(run::Union{Int64, RunMeta}, signal_name::String)::Maybe{WorkspaceArray}

Экспортирует сигнал с идентификатором signal_id в структуру WorkspaceArray. Если сигнала не существует, возвращается nothing.

Или экспортирует сигнал с именем signal_name из прогона run в структуру WorkspaceArray.

Аргументы

signal_id::Int64: идентификатор сигнала, заданный в виде целого числа.
run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.
signal_name::String: имя сигнала, заданное в виде строки.

Примеры

wa1=engee.di.export_signal(1)

WorkspaceArray{Float64}("Sine Wave.1")

wa2=engee.di.export_signal(2,"Sine Wave.1")

WorkspaceArray{Float64}("Sine Wave.1")

# engee.di.export_run — Function

engee.di.export_run(run::Union{Int64, RunMeta})::SimulationResult

Экспортирует прогон run в структуру SimulationResult.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.

Примеры

engee.di.export_run(2)

SimulationResult(
    run_id => 2,
    "Sine Wave.1" => WorkspaceArray{Float64}("Sine Wave.1")
)

# engee.di.get_run_id — Function

engee.di.get_run_id(run::Union{Int64, RunMeta})::RunID

Получает идентификатор прогона RunID для прогона run.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.

Примеры

engee.di.get_run_id(RunMeta(DateTime("2026-09-23T11:15:11.214"), "test_run", 4, false))

# engee.di.load_session — Function

engee.di.load_session(path::String)

Загружает прогоны из файла .ngdat, расположенного в path.

Аргументы

path::String: путь до файла .ngdat, заданный в виде строки.

Примеры

engee.di.load_session("/user/runs1.ngdat")

# engee.di.note_run — Function

engee.di.note_run(run::Union{Int64, RunMeta}, text::String)

Добавляет заметку text к прогону run.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.
text::String: содержание заметки, заданное в виде строки.

Примеры

engee.di.note_run(1, "note_1")

# engee.di.remove_run — Function

engee.di.remove_run(run::Union{Int64, RunMeta})

Удаляет прогон run.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.

Примеры

engee.di.remove_run(1)

# engee.di.save_session — Function

engee.di.save_session(name::String, path::String)

Сохраняет прогоны в файл .ngdat с именем name, расположенный по пути path.

Аргументы

name::String: имя файла .ngdat, заданное в виде строки.
path::String: путь до файла .ngdat, заданный в виде строки.

Примеры

engee.di.save_session("runs1", "/user/")

# engee.di.runs — Function

engee.di.runs()::Vector{RunMeta}

Возвращает список всех прогонов в Инспекторе данных.

Примеры

engee.di.runs()

2-element Vector{RunMeta}:
 RunMeta(DateTime("2026-09-23T10:37:54.466"), "Run 2: test_model", 2, false)
 RunMeta(DateTime("2026-09-23T10:36:48.619"), "Run 1: test_model", 1, true)

# engee.di.signals — Function

engee.di.signals(run::Union{Int64, RunMeta})::Vector{SignalMeta}

Возвращает список всех сигналов прогона run.

Аргументы

run::Union{Int64, RunMeta}: прогон, заданный в виде RunID или структуры RunMeta.

Примеры

engee.di.signals(2)

1-element Vector{SignalMeta}:
 SignalMeta("Sine Wave.1", 2, Float64, ())

Публичные методы программного управления инспектором данных

Методы DataInspector

Методы `DataInspector`