OpenTD.Results.Dataset.Topology.IDatasetTopology Interface Reference
Last update: 16.07.2025Provides access to the underlying logical topology for a dataset. More...
Public Member Functions | |
| List< INodeInfo > | GetSubmodelNodes (string submodel) |
| Gets the INodeInfo for the given Submodel. | |
| INodeInfo | GetNode (SindaName sindaName) |
| Gets the INodeInfo with the given SindaName. | |
| List< IConductorInfo > | GetSubmodelConductors (string submodel) |
| Gets the IConductorInfo for the given Submodel. | |
| List< IConductorInfo > | GetConductorList (SindaName conductorSindaName) |
| Gets the list of IConductorInfo with the given SindaName. | |
| List< ILumpInfo > | GetSubmodelLumps (string submodel) |
| Gets the ILumpInfo for the given Submodel. | |
| ILumpInfo | GetLump (SindaName sindaName) |
| Gets the ILumpInfo with the given SindaName. | |
| List< IPathInfo > | GetSubmodelPaths (string submodel) |
| Gets the IPathInfo for the given Submodel. | |
| IPathInfo | GetPath (SindaName sindaName) |
| Gets the IPathInfo with the given SindaName. | |
| List< ITieInfo > | GetSubmodelTies (string submodel) |
| Gets the ITieInfo for the given Submodel. | |
| ITieInfo | GetTie (SindaName sindaName) |
| Gets the ITieInfo with the given SindaName. | |
| List< IIFaceInfo > | GetSubmodelIFaces (string submodel) |
| Gets the IIFaceInfo's for the given Submodel. | |
| IIFaceInfo | GetIFace (SindaName sindaName) |
| Gets the IIFaceInfo with the given SindaName. | |
| List< IFTieInfo > | GetSubmodelFTies (string submodel) |
| Gets the IFTieInfo for the given Submodel. | |
| IFTieInfo | GetFTie (SindaName sindaName) |
| Gets the IFTieInfo with the given SindaName. | |
Properties | |
| List< INodeInfo > | Nodes [get] |
| Gets the list of INodeInfo objects in the topology. | |
| List< IConductorInfo > | Conductors [get] |
| Gets the list of IConductorInfo objects in the topology. | |
| List< ILumpInfo > | Lumps [get] |
| Gets the list of ILumpInfo objects in the topology. | |
| List< IPathInfo > | Paths [get] |
| Gets the list of IPathInfo objects in the topology. | |
| List< ITieInfo > | Ties [get] |
| Gets the list of ITieInfo objects in the topology. | |
| List< IIFaceInfo > | IFaces [get] |
| Gets the list of IIFace objects in the topology. | |
| List< IFTieInfo > | FTies [get] |
| Gets the list of IFTieInfo objects in the topology. | |
Detailed Description
Provides access to the underlying logical topology for a dataset.
The individual 'Info' types correspond to model objects in Thermal Desktop. and describe the connection between them.
- See also
- OpenTD.Results.Dataset.Topology.IConductorInfo, OpenTD.Results.Dataset.Topology.IFTieInfo, OpenTD.Results.Dataset.Topology.IIFaceInfo, OpenTD.Results.Dataset.Topology.ILumpInfo, OpenTD.Results.Dataset.Topology.INodeInfo, OpenTD.Results.Dataset.Topology.IPathInfo, OpenTD.Results.Dataset.Topology.ITieInfo
Member Function Documentation
◆ GetConductorList()
| List< IConductorInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetConductorList | ( | SindaName | conductorSindaName | ) |
Gets the list of IConductorInfo with the given SindaName.
- Parameters
-
conductorSindaName The SindaName of the conductor(s).
- Returns
- A list of IConductorInfo or null if conductors with sindaName do not exist.
There can be two conductors with a single SindaName, one for each direction of the from and to nodes.
◆ GetFTie()
◆ GetIFace()
| IIFaceInfo OpenTD.Results.Dataset.Topology.IDatasetTopology.GetIFace | ( | SindaName | sindaName | ) |
Gets the IIFaceInfo with the given SindaName.
- Parameters
-
sindaName The SindaName of the IFace.
- Returns
- An IIFaceInfo or null if an IFace with sindaName does not exist.
◆ GetLump()
◆ GetNode()
◆ GetPath()
◆ GetSubmodelConductors()
| List< IConductorInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelConductors | ( | string | submodel | ) |
Gets the IConductorInfo for the given Submodel.
- Parameters
-
submodel The submodel to filter upon.
- Returns
- A list of IConductorInfo for submodel
◆ GetSubmodelFTies()
| List< IFTieInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelFTies | ( | string | submodel | ) |
◆ GetSubmodelIFaces()
| List< IIFaceInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelIFaces | ( | string | submodel | ) |
Gets the IIFaceInfo's for the given Submodel.
- Parameters
-
submodel The submodel to filter upon.
- Returns
- A list of IIFaceInfo for submodel
◆ GetSubmodelLumps()
| List< ILumpInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelLumps | ( | string | submodel | ) |
◆ GetSubmodelNodes()
| List< INodeInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelNodes | ( | string | submodel | ) |
◆ GetSubmodelPaths()
| List< IPathInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelPaths | ( | string | submodel | ) |
◆ GetSubmodelTies()
| List< ITieInfo > OpenTD.Results.Dataset.Topology.IDatasetTopology.GetSubmodelTies | ( | string | submodel | ) |
◆ GetTie()
Property Documentation
◆ Conductors
|
get |
Gets the list of IConductorInfo objects in the topology.
◆ FTies
|
get |
Gets the list of IFTieInfo objects in the topology.
◆ IFaces
|
get |
Gets the list of IIFace objects in the topology.
◆ Lumps
|
get |
Gets the list of ILumpInfo objects in the topology.
◆ Nodes
|
get |
Gets the list of INodeInfo objects in the topology.
◆ Paths
|
get |
Gets the list of IPathInfo objects in the topology.
◆ Ties
|
get |
Gets the list of ITieInfo objects in the topology.
The documentation for this interface was generated from the following file:
- C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV_ALPHA/buildXX/OpenTD.Results/Dataset/Topology/IDatasetTopology.cs
