Engee documentation

Public methods of programmatic data Inspector management

This section presents software management methods for working with the application. Data Inspector.

With the help of software control, you can:

  • create a run;

  • add signals to the run;

  • view runs and signals;

  • export data from the data inspector to the workspace;

  • use additional methods to work with the data inspector: save the run to a file .ngdat, upload a run from a file .ngdat, delete the run from the data inspector, add a note to the run.

Methods work with objects:

  • RunID::Int64 — the ID of the run as an integer.

  • RunMeta — a run object in the form of a structure that contains fields:

      time     :: DateTime
      name     :: String
      run_id   :: Int64
      archived :: Bool
  • SignalMeta — a signal object in the form of a structure that contains fields:

      name      :: String
      signal_id :: Int64
      datatype  :: DataType
      dimension :: Tuple
  • SimulationResult — an object of simulation results in the form of a structure that contains fields:

      run_id :: Int64
      dict   :: Dict{String, WorkspaceArray}

Methods DataInspector

engee.di.add_to_run(run::Run, signals::Signals...)::Nothing

Adds signals signals to the run run.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : the run, specified as RunID or a structure RunMeta.

  • signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}} : signals, specified as WorkspaceArray or Pair{String, DataFrame}.

Examples

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

# To pass  DataFrame, you need to pass it to  Pair, where the first element will be the signal name.

engee.di.add_to_run(run, "my_signal"=>dataframe, wa2)
engee.di.create_run(name::String, signals::Signals...)::RunMeta

Creates a run RunMeta with the name name and signals signals.

Arguments

  • name::String : the run name, specified as a string.

  • signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}} : signals, specified as WorkspaceArray or Pair{String, DataFrame}.

Examples

engee.di.create_run("test_run",wa2)
BackendLib.CommandControl.DataInspector.RunMeta(DateTime("2026-09-23T11:15:12.079"), "test_run", 4, false)
engee.di.export_signal(signal_id::Int64)::WorkspaceArray

engee.di.export_signal(run::Run, signal_name::String)::Maybe{WorkspaceArray}

Exports a signal with the identifier signal_id to the structure WorkspaceArray. If the signal does not exist, nothing is returned.

Or exports a signal with the name signal_name from the run run to the structure WorkspaceArray.

Arguments

  • signal_id::Int64 : the signal identifier, specified as an integer.

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : the run, specified as RunID or a structure of type RunMeta.

  • signal_name::String : the signal name, specified as a string.

Examples

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(run::Run)::SimulationResult

Exports the run run to the structure SimulationResult.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : a run specified as RunID or as the structure RunMeta.

Examples

engee.di.export_run(2)
SimulationResult(
    run_id => 2,
    "Sine Wave.1" => WorkspaceArray{Float64}("Sine Wave.1")
)
engee.di.get_run_id(run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta})::RunID

Retrieves the run identifier RunID for the run run.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : the run, specified as RunID or a structure of type RunMeta.

Examples

engee.di.get_run_id(BackendLib.CommandControl.DataInspector.RunMeta(DateTime("2026-09-23T11:15:11.214"), "test_run", 4, false))
4
engee.di.load_session(path::String)

Loads runs from the file .ngdat, located at path.

Arguments

  • path::String : the path to the file .ngdat, specified as a string.

Examples

engee.di.load_session("/user/runs1.ngdat")
engee.di.note_run(run::Run, text::String)

Adds a note text to the run run.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : a run, specified as RunID or a structure RunMeta.

  • text::String : the note’s content, specified as a string.

Examples

engee.di.note_run(1, "note_1")
engee.di.remove_run(run::Run)

Deletes the run run.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : a run specified as RunID or a structure of type RunMeta.

Examples

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

Saves runs to the file .ngdat with the name name, located at the path path.

Arguments

  • name::String : the filename .ngdat, specified as a string.

  • path::String : the path to the file .ngdat, specified as a string.

Examples

engee.di.save_session("runs1", "/user/")
engee.di.runs()::Vector{RunMeta}

Returns a list of all runs in the Data Inspector.

Examples

engee.di.runs()
2-element Vector{BackendLib.CommandControl.DataInspector.RunMeta}:
 BackendLib.CommandControl.DataInspector.RunMeta(DateTime("2026-09-23T10:37:54.466"), "Run 2: test_model", 2, false)
 BackendLib.CommandControl.DataInspector.RunMeta(DateTime("2026-09-23T10:36:48.619"), "Run 1: test_model", 1, true)
engee.di.signals(run::Run)::Vector{SignalMeta}

Returns a list of all run signals run.

Arguments

  • run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta} : a run specified as a RunID or a RunMeta structure.

Examples

engee.di.signals(2)
1-element Vector{BackendLib.CommandControl.DataInspector.SignalMeta}:
 BackendLib.CommandControl.DataInspector.SignalMeta("Sine Wave.1", 2, Float64, ())