Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.Results.Dataset.IBrowser Interface Reference

Last update: 16.07.2025

IBrowser interface providing methods for Heatmap and HeatBetween nodes and node collecions. More...

Public Member Functions

List< NodeHeatrates > GetHeatMap (IEnumerable< INodeInfo > nodes)
 Gets the collection of NodeHeatrates for each input node.
 
List< NodeHeatrates > GetHeatMap (IEnumerable< SindaName > nodeNames)
 Gets the collection of NodeHeatrates corresponding to each input node name.
 
HeatratesBetween GetHeatBetweenSubmodels (string fromSubmodel, string toSubmodel)
 Gets the heatrates between submodels. Positive for fromSubmodel -> toSubmodel.
 
HeatratesBetween GetHeatBetween (IEnumerable< INodeInfo > fromNodes, IEnumerable< INodeInfo > toNodes)
 Gets the heat between two INodeInfo collections. Positive for fromNodes -> toNodes.
 
HeatratesBetween GetHeatBetween (IEnumerable< INodeInfo > fromNodes, IEnumerable< ITieInfo > toTies)
 Gets the heat between a INodeInfo collection and a ITieInfo collection. Positive for fromNodes -> toTies.
 

Detailed Description

IBrowser interface providing methods for Heatmap and HeatBetween nodes and node collecions.

Member Function Documentation

◆ GetHeatBetween() [1/2]

HeatratesBetween OpenTD.Results.Dataset.IBrowser.GetHeatBetween ( IEnumerable< INodeInfo > fromNodes,
IEnumerable< INodeInfo > toNodes )

Gets the heat between two INodeInfo collections. Positive for fromNodes -> toNodes.

Parameters
fromNodesFrom nodes.
toNodesTo nodes.
Returns
The HeatRatesBetween object with comparison results.

◆ GetHeatBetween() [2/2]

HeatratesBetween OpenTD.Results.Dataset.IBrowser.GetHeatBetween ( IEnumerable< INodeInfo > fromNodes,
IEnumerable< ITieInfo > toTies )

Gets the heat between a INodeInfo collection and a ITieInfo collection. Positive for fromNodes -> toTies.

Parameters
fromNodesFrom nodes.
toTiesTo ties.
Returns
The HeatRatesBetween object with comparison results.

◆ GetHeatBetweenSubmodels()

HeatratesBetween OpenTD.Results.Dataset.IBrowser.GetHeatBetweenSubmodels ( string fromSubmodel,
string toSubmodel )

Gets the heatrates between submodels. Positive for fromSubmodel -> toSubmodel.

At least one of the submodels must be a thermal submodel.

Parameters
fromSubmodelFrom submodel name. Case insensitive.
toSubmodelTo submodel name. Case insensitive.
Returns
The HeatRatesBetween object with comparison results.
Exceptions
OpenTDExceptionThrown if both input submodel name refer to fluid submodels, or if any submodels don't exist.

◆ GetHeatMap() [1/2]

List< NodeHeatrates > OpenTD.Results.Dataset.IBrowser.GetHeatMap ( IEnumerable< INodeInfo > nodes)

Gets the collection of NodeHeatrates for each input node.

Parameters
nodesA collection of INodeInfo objects for which to map heatrates.
Returns
A collection of NodeHeatrates, one for each of the input nodes.

◆ GetHeatMap() [2/2]

List< NodeHeatrates > OpenTD.Results.Dataset.IBrowser.GetHeatMap ( IEnumerable< SindaName > nodeNames)

Gets the collection of NodeHeatrates corresponding to each input node name.

Parameters
nodeNamesA collection of INodeInfo SindaNames.
Returns
A collection of NodeHeatrates, one for each of the input node names.

The documentation for this interface was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD.Results/Dataset/IBrowser.cs

Connect with Ansys