Tools¶
Properties of a tool can be found in the Properties Window in MIKE Workbench after selecting the tool in the Analysis Explorer.
Compare sessions¶
Tool for comparing analysis sessions.
| Tool Info | |
|---|---|
| Display Name | Compare sessions |
| API Name | Compare sessions |
| Tools Explorer | /Compare session/Compare sessions |
| NuGet Package | DHI.MikeOperations.AnalysisManager.Tools.CompareSession |
| Assembly name (.dll) | DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.dll |
| API Reference | DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.ICompareSessionTool |
| Input Items | Two or more multi criteria analysis sessions |
| Output Items | A session comparison |
Tool Properties
| Display Name | API Name | Description |
|---|---|---|
| Comparison sheet | ||
| Name | ComparsionSheetName | Gets or sets a name of the output sheet |
Code Sample
import clr
clr.AddReference("DHI.Solutions.AnalysisManager.Tools.CompareSessionTool")
from DHI.Solutions.AnalysisManager.Tools.CompareSessionTool import *
# Get the tool.
tool = app.Tools.CreateNew("Compare sessions")
# Add input items.
tool.InputItems.Add(<Two or more multi criteria analysis sessions>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.AnalysisManager.Tools.CompareSessionTool")
from DHI.Solutions.AnalysisManager.Tools.CompareSessionTool import *
# Get the tool.
tool = DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.ICompareSessionTool(app.Tools.CreateNew("Compare sessions"))
# Add input items.
tool.InputItems.Add(<Two or more multi criteria analysis sessions>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Compare sessions") as DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.ICompareSessionTool;
// Add input items.
tool.InputItems.Add(<Two or more multi criteria analysis sessions>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config file.
<Plugin
Name="DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.CompareSessionTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.AnalysisManager.Tools.CompareSessionTool.dll" />