程序化数据检查器管理的公共方法
本节介绍使用应用程序的软件管理方法。 数据检查员.
借助软件控制,您可以:
*创建运行;
*向运行添加信号;
*查看运行和信号;
*将数据从数据检查器导出到工作区;
*使用其他方法处理数据检查器:将运行保存到文件 .ngdat,从文件上传运行 .ngdat,从数据检查器中删除运行,在运行中添加注释。
方法与对象一起工作:
-
鲁尼德:Int64-运行的id作为整数。 -
朗梅塔-包含字段的结构形式的运行对象:time :: DateTime name :: String run_id :: Int64 archived :: Bool
-
信号梅塔-包含字段的结构形式的信号对象:name :: String signal_id :: Int64 datatype :: DataType dimension :: Tuple
-
模拟结果-模拟对象以包含字段的结构形式产生:run_id :: Int64 dict :: Dict{String, WorkspaceArray}
方法 数据探测仪
#
engee.di.add_to_run — Function
engee.di.add_to_run(run::Run, signals::Signals...)::Nothing
将信号signals 添加到运行run 中。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.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::Signals...)::RunMeta
创建名为name 且包含信号signals 的运行RunMeta 。
参数
-
name::String: 以字符串形式指定的运行名称。 -
signals::Vararg{Union{Pair{String, DataFrame}, WorkspaceArray}}: 以WorkspaceArray或Pair{String, DataFrame}形式指定的信号。
示例
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 — Function
engee.di.export_signal(signal_id::Int64)::WorkspaceArray
engee.di.export_signal(run::Run, signal_name::String)::Maybe{WorkspaceArray}
将标识符为signal_id 的信号导出到结构体WorkspaceArray 中。如果该信号不存在,则返回nothing 。
或者将名称为signal_name 的信号从运行run 导出到结构体WorkspaceArray 中。
参数
-
signal_id::Int64:以整数形式指定的信号标识符。 -
run::Union{Int64, BackendLib.CommandControl.DataInspector.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::Run)::SimulationResult
将运行run 导出到结构SimulationResult 中。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.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, BackendLib.CommandControl.DataInspector.RunMeta})::RunID
获取运行RunID 的运行标识符,该运行位于run 。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta}:以RunID或结构RunMeta形式指定的运行。
示例
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 — Function
engee.di.load_session(path::String)
从位于path 的文件.ngdat 中加载运行。
参数
-
path::String:以字符串形式指定的文件.ngdat的路径。
示例
engee.di.load_session("/user/runs1.ngdat")
#
engee.di.note_run — Function
engee.di.note_run(run::Run, text::String)
将注释text 添加到运行run 中。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta}:以RunID或结构RunMeta形式指定的运行。 -
text::String: 以字符串形式指定的注释内容。
示例
engee.di.note_run(1, "note_1")
#
engee.di.remove_run — Function
engee.di.remove_run(run::Run)
删除运行run 。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta}: 以RunID或结构RunMeta形式指定的运行。
示例
engee.di.remove_run(1)
#
engee.di.save_session — Function
engee.di.save_session(name::String, path::String)
将运行结果保存到位于路径path 的文件.ngdat 中,文件名为name 。
参数
-
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{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 — Function
engee.di.signals(run::Run)::Vector{SignalMeta}
返回所有运行信号的列表run 。
参数
-
run::Union{Int64, BackendLib.CommandControl.DataInspector.RunMeta}:以RunID或结构RunMeta形式指定的运行。
示例
engee.di.signals(2)
1-element Vector{BackendLib.CommandControl.DataInspector.SignalMeta}:
BackendLib.CommandControl.DataInspector.SignalMeta("Sine Wave.1", 2, Float64, ())