API Documentation

API Index

This index links to the detailed API descriptions below.

Core Functions

• sir3stoolkit.core.wrapper.Initialize_Toolkit()

• sir3stoolkit.core.wrapper.Read_SirGraf_Config_Path()

• sir3stoolkit.core.wrapper.Write_SirGraf_Config_Path()

• sir3stoolkit.core.wrapper.create_dotnet_enum()

Core Methods: SIR3S_Model

• sir3stoolkit.core.wrapper.SIR3S_Model.to_dotnet_enum()

• sir3stoolkit.core.wrapper.SIR3S_Model.to_python_enum()

• sir3stoolkit.core.wrapper.SIR3S_Model.StartTransaction()

• sir3stoolkit.core.wrapper.SIR3S_Model.EndTransaction()

• sir3stoolkit.core.wrapper.SIR3S_Model.StartEditSession()

• sir3stoolkit.core.wrapper.SIR3S_Model.EndEditSession()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetCurrentTimeStamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetCurrentTimeStamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetValue()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetValue()

• sir3stoolkit.core.wrapper.SIR3S_Model.OpenModelXml()

• sir3stoolkit.core.wrapper.SIR3S_Model.OpenModel()

• sir3stoolkit.core.wrapper.SIR3S_Model.CloseModel()

• sir3stoolkit.core.wrapper.SIR3S_Model.ExecCalculation()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetTimeStamps()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetTksofElementType()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetNetworkType()

• sir3stoolkit.core.wrapper.SIR3S_Model.IsMainContainer()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetMainContainer()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetElementInfo()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetNumberOfElements()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetPropertiesofElementType()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetObjectTypeof_Key()

• sir3stoolkit.core.wrapper.SIR3S_Model.DeleteElement()

• sir3stoolkit.core.wrapper.SIR3S_Model.InsertElement()

• sir3stoolkit.core.wrapper.SIR3S_Model.NewModel()

• sir3stoolkit.core.wrapper.SIR3S_Model.ConnectConnectingElementWithNodes()

• sir3stoolkit.core.wrapper.SIR3S_Model.ConnectBypassElementWithNode()

• sir3stoolkit.core.wrapper.SIR3S_Model.SaveChanges()

• sir3stoolkit.core.wrapper.SIR3S_Model.AddTableRow()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetTableRows()

• sir3stoolkit.core.wrapper.SIR3S_Model.RefreshViews()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetInsertPoint()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetElementColor_RGB()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetElementColor()

• sir3stoolkit.core.wrapper.SIR3S_Model.AlignElement()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetResultValue()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetResultProperties_from_elementType()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetResultProperties_from_elementKey()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetMinResult()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetMaxResult()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetMinResult_for_timestamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetMaxResult_for_timestamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.AddNewNode()

• sir3stoolkit.core.wrapper.SIR3S_Model.AddNewPipe()

• sir3stoolkit.core.wrapper.SIR3S_Model.AddNewConnectingElement()

• sir3stoolkit.core.wrapper.SIR3S_Model.AddNewBypassElement()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetTkFromIDReference()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetGeometryInformation()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetGeometryInformation()

• sir3stoolkit.core.wrapper.SIR3S_Model.AllowSirMessageBox()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetEndNodes()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetLogFilePath()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetLogFilePath()

• sir3stoolkit.core.wrapper.SIR3S_Model.EnableOrDisableOutputComments()

• sir3stoolkit.core.wrapper.SIR3S_Model.EnableOrDisable_ObjectTypes_TableNames_Enum()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetResultfortimestamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetResultforAllTimestamp()

• sir3stoolkit.core.wrapper.SIR3S_Model.CreateModelRepair()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetHydraulicProfileObjectString()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetCourseOfHydraulicProfile()

• sir3stoolkit.core.wrapper.SIR3S_Model.ExecuteModelValidation()

• sir3stoolkit.core.wrapper.SIR3S_Model.ExecuteResultsCheck()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetWorkingDirectory()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetDBSourcePath()

• sir3stoolkit.core.wrapper.SIR3S_Model.AllocateWorkingDirectory()

• sir3stoolkit.core.wrapper.SIR3S_Model.CreateWorkingDirectory()

• sir3stoolkit.core.wrapper.SIR3S_Model.CopyWorkingDirectory()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetCalculationType()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetCalculationType()

• sir3stoolkit.core.wrapper.SIR3S_Model.WriteSirCalcXmlFile()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetThermalCalculationParemeters()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetThermalCalculationParemeters()

• sir3stoolkit.core.wrapper.SIR3S_Model.SetSimulationTimeFrame()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetSimulationTimeFrame()

• sir3stoolkit.core.wrapper.SIR3S_Model.GetGeometryData()

Core Methods: SIR3S_View

• sir3stoolkit.core.wrapper.SIR3S_View.to_dotnet_enum()

• sir3stoolkit.core.wrapper.SIR3S_View.to_python_enum()

• sir3stoolkit.core.wrapper.SIR3S_View.StartTransaction()

• sir3stoolkit.core.wrapper.SIR3S_View.EndTransaction()

• sir3stoolkit.core.wrapper.SIR3S_View.StartEditSession()

• sir3stoolkit.core.wrapper.SIR3S_View.EndEditSession()

• sir3stoolkit.core.wrapper.SIR3S_View.SaveChanges()

• sir3stoolkit.core.wrapper.SIR3S_View.OpenModelXml()

• sir3stoolkit.core.wrapper.SIR3S_View.OpenModel()

• sir3stoolkit.core.wrapper.SIR3S_View.CloseModel()

• sir3stoolkit.core.wrapper.SIR3S_View.GetMainContainer()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolyline()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolyline_using_LineString()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolylinePoint()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalPolyLineWidthAndColor()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolygon()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolygon_using_LineString()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalPolygonPoint()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalPolygonProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalText()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalTextText()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalTextProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalArrow()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalArrowProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalRectangle()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalRectangleProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.AddExternalEllipse()

• sir3stoolkit.core.wrapper.SIR3S_View.SetExternalEllipseProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.PrepareColoration()

• sir3stoolkit.core.wrapper.SIR3S_View.InitColorTable()

• sir3stoolkit.core.wrapper.SIR3S_View.GetColor()

• sir3stoolkit.core.wrapper.SIR3S_View.GetColorTableEntries()

• sir3stoolkit.core.wrapper.SIR3S_View.SetWidthScaleProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.GetWidthFactor()

• sir3stoolkit.core.wrapper.SIR3S_View.ColoratePipe()

• sir3stoolkit.core.wrapper.SIR3S_View.ResetColoration()

• sir3stoolkit.core.wrapper.SIR3S_View.DoColoration()

• sir3stoolkit.core.wrapper.SIR3S_View.MoveElementTo()

• sir3stoolkit.core.wrapper.SIR3S_View.MoveElementBy()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewText()

• sir3stoolkit.core.wrapper.SIR3S_View.GetTextProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewNumericalDisplay()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewDirectionalArrow()

• sir3stoolkit.core.wrapper.SIR3S_View.GetNumericalDisplayProperties()

• sir3stoolkit.core.wrapper.SIR3S_View.SetFont()

• sir3stoolkit.core.wrapper.SIR3S_View.GetFont()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewStreet()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewHouse()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewCustomer()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewValveOnPipe()

• sir3stoolkit.core.wrapper.SIR3S_View.AddNewHydrant()

• sir3stoolkit.core.wrapper.SIR3S_View.RemoveAllExternalVisualObjects()

• sir3stoolkit.core.wrapper.SIR3S_View.EnableOrDisableOutputComments()

• sir3stoolkit.core.wrapper.SIR3S_View.RefreshViews()

• sir3stoolkit.core.wrapper.SIR3S_View.UnmarkAll()

• sir3stoolkit.core.wrapper.SIR3S_View.GetMarkedElements()

• sir3stoolkit.core.wrapper.SIR3S_View.MarkElement()

• sir3stoolkit.core.wrapper.SIR3S_View.UnmarkElement()

• sir3stoolkit.core.wrapper.SIR3S_View.IsElementMarked()

Core Methods: SIR3S_ModelRepair

• sir3stoolkit.core.wrapper.SIR3S_ModelRepair.GetListOfRepairTool()

• sir3stoolkit.core.wrapper.SIR3S_ModelRepair.CheckRepairTool()

• sir3stoolkit.core.wrapper.SIR3S_ModelRepair.ExecuteRepairTool()

Mantle Methods: SIR3S_Model_Dataframes

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.generate_element_model_data_dataframe()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.generate_element_results_dataframe()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.convert_rows_to_single_tuple_row()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.generate_element_dataframe()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.add_interior_points_as_multiindex()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.add_interior_points_to_start_end_sequence()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.add_interior_points_as_flat_cols()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.generate_longitudinal_section_dataframes()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.generate_edge_dataframe()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.merge_model_data_and_results()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.get_EPSG()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.delete_elements_in_dataframe()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.get_dataframes_from_nominal_diameter_tables()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.insert_dataframe_into_time_table()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.get_dataframes_from_time_table_type()

• sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes.get_dataframe_from_time_table()

Mantle Methods: SIR3S_Model_Alternative_Models

• sir3stoolkit.mantle.alternative_models.SIR3S_Model_Alternative_Models.SIR_3S_to_pandapipes()

• sir3stoolkit.mantle.alternative_models.SIR3S_Model_Alternative_Models.SIR_3S_to_nx_graph()

• sir3stoolkit.mantle.alternative_models.SIR3S_Model_Alternative_Models.add_properties_to_graph()

• sir3stoolkit.mantle.alternative_models.SIR3S_Model_Alternative_Models.get_object_type_enum()

Mantle Methods: SIR3S_Model_Plotting

• sir3stoolkit.mantle.plotting.SIR3S_Model_Plotting.plot_pipe_layer()

• sir3stoolkit.mantle.plotting.SIR3S_Model_Plotting.plot_node_layer()

• sir3stoolkit.mantle.plotting.SIR3S_Model_Plotting.plot_time_curves()

Mantle Methods: SIR3S_Model_Advanced_Operations

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.set_group_elements()

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.add_elements_to_group()

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.remove_elements_from_group()

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.add_element_types_to_tk_list()

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.get_tks_of_group_elements()

• sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations.get_element_type_from_tk()

Utility Functions

• sir3stoolkit.logging_utils.get_logger()

• sir3stoolkit.logging_utils.is_host_process()

• sir3stoolkit.logging_utils.get_process_executable_path()

• sir3stoolkit.logging_utils.get_process_executable_name()

• sir3stoolkit.logging_utils.emit_message()

Core

Created on Fri Nov 22 14:46:49 2024

@author: Nischal Giriyan

class sir3stoolkit.core.wrapper.DotNetEnumMeta(cls, bases, classdict, **kwargs)

Bases: EnumType

sir3stoolkit.core.wrapper.Initialize_Toolkit(basePath: str | None = None)

Initialize the SIR 3S Toolkit with the SirGraf installation path.

This function must be called before creating any instances of the classes provided by this package.

Path resolution order: 1. Use basePath when it is provided and not empty. 2. Otherwise, if Toolkit is used in SIR Graf console, use its directory. 3. Otherwise, try config.local.txt in the package root directory

(sir3stoolkit/config.local.txt), then config.txt in the same location, and read the first non-empty, non-comment line. Format: C:/3S/SIR 3S/SirGraf-90-15-00-24_Quebec-Upd2

Parameters:

basePath (Optional[str]) – Optional full path to the SirGraf directory.

Raises:

RuntimeError – If basePath, host app inspection, and config files do not provide a valid SirGraf path.

Returns:

None

Return type:

None

sir3stoolkit.core.wrapper.Read_SirGraf_Config_Path() → str | None

Read the SirGraf directory path configured in the package’s config file.

Reads the first non-empty, non-comment line from config.txt in the package root directory (sir3stoolkit/config.txt). If config.local.txt is also present in that directory (developer override), it is checked first and takes precedence.

Raises:

FileNotFoundError – If the configured path does not exist or is not a directory.

Returns:

The configured SirGraf directory path, or None if no config file exists or contains a usable path.

Return type:

Optional[str]

class sir3stoolkit.core.wrapper.SIR3S_Model

Bases: object

Class definition of SIR3S_Model() wrapper to access functionalities provided by SIR3S software. This can be used independently or by using inside python console plugin to give better control over the model for users.

AddNewBypassElement(tkCont: str, tkFrom: str, x: float64, y: float64, z: float32, symbolFactor: float64, elementType, idRef: str, description: str) → str

Inserts a new bypass element.

Parameters:

• tkCont (str) – The TK of the container (view) in which the new object shall be inserted. Entering a value of “-1” means the main view of the model.

• tkFrom (str) – Tk (key) of the start node.

• x (np.float64) – X coordinate.

• y (np.float64) – Y coordinate.

• z (np.float32) – Z coordinate.

• symbolFactor (np.float64) – The symbol factor of the new node.

• elementType (ObjectTypes) – Element type.

• idRef (str) – ID in reference system.

• description (str) – Description.

Returns:

The key (TK) of the added bypass element, otherwise ‘-1’ if something went wrong.

Return type:

str

Description:

Comfortable method for inserting a new bypass element.

AddNewConnectingElement(tkCont: str, tkFrom: str, tkTo: str, x: float64, y: float64, z: float32, elementType, dn: float32, symbolFactor: float64, angleDegree: float32, idRef: str, description: str) → str

Inserts a new connecting element.

Parameters:

• tkCont (str) – The TK of the container (view) in which the new object shall be inserted. Entering a value of “-1” means the main view of the model.

• tkFrom (str) – Tk (key) of the start node.

• tkTo (str) – Tk (key) of the end node.

• x (np.float64) – X coordinate.

• y (np.float64) – Y coordinate.

• z (np.float32) – Z coordinate.

• elementType (ObjectTypes) – Element type.

• dn (np.float32) – The nominal diameter or the Tk of the nominal diameter.

• symbolFactor (np.float64) – The symbol factor of the new node.

• angleDegree (np.float32) – The symbol angle in degrees.

• idRef (str) – ID in reference system.

• description (str) – Description.

Returns:

The key (TK) of the added connecting element, otherwise ‘-1’ if something went wrong.

Return type:

str

Description:

Comfortable method for inserting a new connecting element.

AddNewNode(tkCont: str, name: str, typ: str, x: float64, y: float64, z: float32, qm_PH: float32, symbolFactor: float64, description: str, idRef: str, kvr: int) → str

Inserts a new node.

Parameters:

• tkCont (str) – The TK of the container (view) in which the new object shall be inserted. Entering a value of “-1” means the main view of the model.

• name (str) – Name of the new node.

• typ (str) – Type of the new node.

• x (np.float64) – X coordinate.

• y (np.float64) – Y coordinate.

• z (np.float32) – Geodetic height.

• qm_PH (np.float32) – Value for extraction/feeding (in case QKON) or pressure (in case PKON or PKQN).

• symbolFactor (np.float64) – The symbol factor of the new node.

• description (str) – Description.

• idRef (str) – ID in reference system.

• kvr (int) – SL/RL flag. Should be 0 (undefined), 1 (SL) or 2 (RL).

Returns:

The key (TK) of the added node, otherwise ‘-1’ if something went wrong.

Return type:

str

Description:

Comfortable method for inserting a new node.

AddNewPipe(tkCont: str, tkFrom: str, tkTo: str, L: float32, linestring: str, material: str, dn: str, roughness: float32, idRef: str, description: str, kvr: int) → str

Inserts a new pipe.

Parameters:

• tkCont (str) – The TK of the container (view) in which the new object shall be inserted. Entering a value of “-1” means the main view of the model.

• tkFrom (str) – Tk (key) of the start node.

• tkTo (str) – Tk (key) of the end node.

• L (np.float32) – The pipe length, mandatory for computation.

• linestring (str) – An optional string with intermediate points for geometry formatted like ‘LINESTRING (120 76, 500 300, 620 480)’. The insert points of from and to will be added on both ends of the geometry.

• material (str) – Name or Tk (key) of the pipe diameter table.

• dn (str) – The nominal diameter or the Tk of the nominal diameter.

• roughness (np.float32) – Roughness of pipe.

• description (str) – Description.

• idRef (str) – ID in reference system.

• kvr (int) – SL/RL flag. Should be 0 (undefined), 1 (SL) or 2 (RL).

Returns:

The key (TK) of the added pipe, otherwise ‘-1’ if something went wrong.

Return type:

str

Description:

Comfortable method for inserting a new pipe.

AddTableRow(tablePkTk: str)

Adds a row to the specified table.

Parameters:

tablePkTk (str) – Key of the table.

Returns:

Tk of the inserted row and object type.

Return type:

tuple[str, ObjectTypes]

Description:

This is a wrapper method for AddTableRow() from toolkit; Watch out for errors for more information.

AlignElement(elementKey: str)

Aligns the specified element.

Parameters:

elementKey (str) – Key of the symbol-object.

Returns:

None

Return type:

None

Description:

This is a wrapper method for AlignElement() from toolkit; Watch out for errors for more information.

AllocateWorkingDirectory(strDirectory) → bool

Assign the SIR 3S working Directory to an existing Directory. WARNING: If you change the working directory, the model will disconnect from the mx results. If you want to read results in the newly allocated working directory, reopen the model after closing it.

Parameters:

strDirectory (str) – The path of the Directory to allocate. This must be a valid, existing, writable and readable Directory Path.

Returns:

True if the allocation is successful; otherwise, false.

Return type:

bool

Description:

This is a wrapper method for AllocateWorkingDirectory() from toolkit

AllowSirMessageBox(bAllow: bool)

Use this method for allowing SIR DB Message Boxes to pop or not

Parameters:

bAllow (bool) – Allow/not allow

Returns:

None

Return type:

None

Description:

This is a wrapper method for AllowSirMessageBox() from toolkit

CloseModel(saveChangesBeforeClosing: bool) → bool

Closes a currently open Model.

Parameters:

saveChangesBeforeClosing (bool) – If True, the Changes would be saved before Closing otherwise Changes would be discarded

Returns:

return True if model is successfully closed, False otherwise

Return type:

bool

Description:

This is a wrapper method for CloseModel() from toolkit; Watch out for errors for more information.

ConnectBypassElementWithNode(Tk: str, keyOfNodeI: str)

Connects the specified bypass element with a node.

Parameters:

• Tk (str) – Tk of the connecting object.

• keyOfNodeI (str) – Tk of node I (element that needs to be connected).

Returns:

None

Return type:

None

Description:

This is a wrapper method for ConnectBypassElementWithNode() from toolkit; Watch out for errors for more information.

ConnectConnectingElementWithNodes(Tk: str, keyOfNodeI: str, keyOfNodeK: str)

Connects the specified connecting element with nodes.

Parameters:

• Tk (str) – Tk of the connecting object.

• keyOfNodeI (str) – Tk of node I (one of the elements that needs to be connected).

• keyOfNodeK (str) – Tk of node K (other element that needs to be connected).

Returns:

None

Return type:

None

Description:

This is a wrapper method for ConnectConnectingElementWithNodes() from toolkit; Watch out for errors for more information.

CopyWorkingDirectory(strDestinationDirectory) → bool

Copies the contents of the current SIR 3S working Directory to the specified Destination Directory. The current User should have SIR 3S Adminitrator Role.

Parameters:

strDestinationDirectory (str) – The full Path of the Destination Directory where the Contents will be copied. Must be a valid writable Directory Path.

Returns:

True if the Copy Operation is successful; otherwise, false.

Return type:

bool

Description:

This is a wrapper method for CopyWorkingDirectory() from toolkit

CreateModelRepair()

Creates an instance to access all model repair functionalities

Returns:

modelRepair

Return type:

instance of model repair created in .NET

Description:

This is a wrapper method for CreateModelRepair() from toolkit

CreateWorkingDirectory(strDirectory) → bool

Just Create a SIR 3S Working Directory if it doesnt exist yet and assign it. The current User should have SIR 3S Adminitrator Role.

Parameters:

strDirectory (str) – The Directory to create.

Returns:

True if the Creation is successful; otherwise, false.

Return type:

bool

Description:

This is a wrapper method for CreateWorkingDirectory() from toolkit

DeleteElement(Tk: str)

Deletes the specified element.

Parameters:

Tk (str) – The pk/tk of the element to be deleted.

Returns:

None

Return type:

None

Description:

This is a wrapper method for DeleteElement() from toolkit; Watch out for errors for more information.

EnableOrDisableOutputComments(outputComments: bool)

Enable or disable additional output comments while using methods from SIR3S_Model class. These comments could help you understand about the positive outcome of a method. Default value is True

Parameters:

outputComments (bool) – To enable pass true and to disable pass false

Returns:

None

Return type:

None

Description:

This is a helper function

EnableOrDisable_ObjectTypes_TableNames_Enum(enable_param: bool)

Enable ObjectTypes_TableNames Enum which is german version for the ObjectTypes for all applicable return values. User can pass True/False to this function to enabe or disable this conversion. If enabled user will receive all outputs of type ObjectTypes enum in the german version(i.e,. ObjectTypes_TableNames) Default value is False

Parameters:

enable_param (bool) – To enable pass true and to disable pass false

Returns:

None

Return type:

None

Description:

This is a helper function

EndEditSession()

End the current edit session.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for EndEditSession() from toolkit.

Closes an already started EditSession. Should always be called after a Call of StartEditSession() and all the Modifications applied.

EndTransaction()

End the current transaction.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for EndTransaction() from toolkit.

If Modifications on a Model are intended, it is recommended to make a Call of StartTransaction(), then do all the Modifications you need. And then call EndTransaction() as soon as you are finished with Modifications. This helps the Software to keep Track of Modifications, so the User can Undo/Redo them on the main UI (SirGraf).

ExecCalculation(waitForSirCalcToExit: bool)

Executes the model calculation.

Parameters:

waitForSirCalcToExit (bool) – Do you want to wait for SirCalc engine to exit before proceeding?

Returns:

None

Return type:

None

Description:

This is a wrapper method for ExecCalculation() from toolkit; Watch out for errors for more information. Use Exit_status = instance.GetResultValue(instance.GetTksofElementType(instance.ObjectTypes.GeneralSection)[0],”EXSTAT”)[0] afterwards to check status of calculation.

ExecuteModelValidation()

This method executes the model validation.

Returns:

returns the results of the model validation. Use json to unpack.

Return type:

tuple

Description:

This is a wrapper method for ExecuteModelValidation() from toolkit

ExecuteResultsCheck()

This method executes check of results.

Returns:

returns the result check and datapoint check results. Use json to unpack.

Return type:

tuple

Description:

This is a wrapper method for ExecuteResultsCheck() from toolkit

GetCalculationType()

Gets the current Type of Calculation to be performed.

Returns:

value representing the type of calculation. Returns ‘Unknown’ if the operation fails.

Return type:

CalculationType

Description:

This is a wrapper method for GetCalculationType() from toolkit

GetCourseOfHydraulicProfile(tkAgsn, uid) → hydraulicProfile

This method gets the detailed Course of a Hydraulic Profile that may also have Branches.

Parameters:

• tkAgsn (str) – Tk of agsn

• uid (str) – UID The internal Number of the Way/Branch to retrieve. For obtaining the Main Way of a Hydraulic Profile, just enter ‘0’ or an empty String

Returns:

returns a namedtuple combining all the hydraulic profile information

Return type:

hydraulicProfile(namedtuple)

Description:

This is a wrapper method for GetCourseOfHydraulicProfile() from toolkit

GetCurrentTimeStamp() → str

Returns the value of the current time stamp.

Returns:

Current time stamp.

Return type:

str

Description:

This is a wrapper method to access the get method for the property CurrentTimestamp from toolkit.

GetDBSourcePath() → tuple[str, str, str, str]

Retrieves the Database Source Path along with Connection Details.

Returns:

returns four string elementswrapped in as a tuple (dbPath, conectionString, dbVendor, dbName) dbPath contains the full Path to the Database File. This will return an empty String for all Database Types, except from SQLite, XMLFILE and ACCESS. conectionString contains the ADO.NET Connection String for the Database. For XML File Databases, this will return an empty String dbVendor contains the Database Type. dbName contains the Name of the Database.

Return type:

tuple[str, str, str, str]

Description:

This is a wrapper method for GetDBSourcePath() from toolkit

GetElementInfo(Tk: str)

Gets the element information.

Parameters:

Tk (str) – The pk/tk of the element in question.

Returns:

None

Return type:

None

Description:

This is a wrapper method for GetElementInfo() from toolkit; Watch out for errors for more information.

Gets a short ToolTip Text for a SIR 3S Element.

GetEndNodes(Tk: str) → tuple[str, str, str, str]

General Methot for getting the Tk (keys) of Endnodes connected to an Element. In SIR 3S, they exists Elements that have: Only 1 Endnodes (i.e. Tanks, Air Valves, …) : Bypass Elements in General

2 Endnodes (i.e. Pipes, Pumps, Flap Valves, …): Connecting Elements in General 4 Endnodes (Heat Exchangers)

This Method always return for unconnected or non-existent Sides a fkkX Value of ‘-1’

Parameters:

Tk (str) – The Tk (key) of the Element we need to retrieve the Endnodes

Returns:

fkKI, fkKK, fkKI2, fkKK2

Return type:

tuple[str, str, str, str]

Description:

This is a wrapper method for GetEndNodes() from toolkit

GetGeometryData(elemTk)

Retrieves the WKB Geometry Data if an Element (Technical Data Part, OS Data Part, and eventually connection Lines).

Parameters:

elemTk (str) – The Key (PK/TK) representing the element for which Geometry Gata is requested.

Returns:

Returns a boolean result, geometrySACH, geometryBZ, geomCnLnI, geomCnLnK, geomCnLnI2, geomCnLnK2 as a tuple Boolean result - True if the Geometry Data was successfully retrieved; otherwise, False. geometrySACH - Receives the Technical Data Part of the Geometry if there is any. geometryBZ - Receives the OS Data Part of the Geometry, if the operation is successful. geomCnLnI - Receives the Geometry for the connection line (I) to the Upstream Node if there is any. geomCnLnK - Receives the Geometry for the connection line (K) to the Downstream Node if there is any. geomCnLnI2 - Receives the Geometry for the second connection line (I2) to the Upstream Node if there is any. (HeatExchanger only) geomCnLnK2 - Receives the Geometry for the second connection line (K2) to the Downstream Node if there is any.(HeatExchanger only)

Return type:

tuple[bool, str, str, str, str, str, str]

Description:

This is a wrapper method for GetGeometryData() from toolkit

GetGeometryInformation(Tk: str) → str

Extracts the technical geometry information (Sachdatengeometrie) of an element using its TK.

Parameters:

Tk (str) – TK of the element whose geometry information is needed.

Returns:

Geometry information of the element.

Return type:

str

Description:

This is a wrapper method for GetGeometryInformation() from toolkit; Watch out for error messages for more information.

GetHydraulicProfileObjectString(tkAgsn) → bool

This Method retrieves the raw representation of the Course of a Hydraulic Profile. That is the String saved in the ‘OBJS’ Field of the AGSN Table (Persistence).

Parameters:

tkAgsn (str) – Tk of agsn

Returns:

returns true if successfully able to retrieve Hydraulic Profile, false otherwise

Return type:

bool

Returns:

returns agsn string as output

Return type:

str

Description:

This is a wrapper method for GetHydraulicProfileObjectString() from toolkit

GetLogFilePath() → str

Gets the value of the actual full Path of the Log File

Returns:

logFilePath

Return type:

str

Description:

This is a wrapper method for GetLogFilePath() from toolkit

GetMainContainer()

Finds the main container of the model and returns its Key (TK).

Returns:

Tk of the main container and object type.

Return type:

tuple[str, ObjectTypes]

Description:

This is a wrapper method for GetMainContainer() from toolkit.

GetMaxResult(elementType, propertyName: str) → tuple[str, str, str]

Gets the maximal result value of an element type and also the key (tk/pk) of the corresponding element.

Parameters:

• elementType (ObjectTypes) – The element type.

• propertyName (str) – The name of the result property.

Returns:

The maximal result value of an element type, the key (tk/pk) of the corresponding element, and the data type of the result.

Return type:

tuple[str, str, str]

Description:

This is a wrapper method for GetMaxResult() from toolkit; Watch out for errors for more information.

GetMaxResult_for_timestamp(timestamp: str, elementType, propertyName: str) → tuple[str, str, str]

Gets the maximal result value of an element type at a particular timestamp and also the key (tk/pk) of the corresponding element.

Parameters:

• timestamp (str) – The timestamp for which result is needed.

• elementType (ObjectTypes) – The element type.

• propertyName (str) – The name of the result property.

Returns:

The maximal result value of an element type at a particular timestamp, the key (tk/pk) of the corresponding element, and the data type of the result.

Return type:

tuple[str, str, str]

Description:

This is a wrapper method for GetMaxResult() from toolkit; Watch out for errors for more information.

GetMinResult(elementType, propertyName: str) → tuple[str, str, str]

Gets the minimal result value of an element type and also the key (tk/pk) of the corresponding element.

Parameters:

• elementType (ObjectTypes) – The element type.

• propertyName (str) – The name of the result property.

Returns:

The minimal result value of an element type, the key (tk/pk) of the corresponding element, and the data type of the result.

Return type:

tuple[str, str, str]

Description:

This is a wrapper method for GetMinResult() from toolkit; Watch out for errors for more information.

GetMinResult_for_timestamp(timestamp: str, elementType, propertyName: str) → tuple[str, str, str]

Gets the minimal result value of an element type at a particular timestamp and also the key (tk/pk) of the corresponding element.

Parameters:

• timestamp (str) – The timestamp for which result is needed.

• elementType (ObjectTypes) – The element type.

• propertyName (str) – The name of the result property.

Returns:

The minimal result value of an element type at a particular timestamp, the key (tk/pk) of the corresponding element, and the data type of the result.

Return type:

tuple[str, str, str]

Description:

This is a wrapper method for GetMinResult() from toolkit; Watch out for errors for more information.

GetNetworkType()

Gets the network type.

Returns:

Network type defined in the enum.

Return type:

NetworkType

Description:

This is a wrapper method for GetNetworkType() from toolkit.

GetNumberOfElements(ElementType) → int

Gets the total number of elements of the specified type.

Parameters:

ElementType (ObjectTypes) – Object type defined in the enum.

Returns:

Total number of elements of type ‘ElementType’.

Return type:

int

Description:

This is a wrapper method for GetNumberOfElements() from toolkit.

GetObjectTypeof_Key(Key: str)

Gets the type of object the input Key belongs to.

Parameters:

Key (str) – The pk/tk of the element in question.

Returns:

Type of object the input Key belongs to.

Return type:

ObjectTypes

Description:

This is a wrapper method for GetObjectTypeOf_Key() from toolkit; Watch out for

errors for more information.

GetPropertiesofElementType(ElementType) → list

Gets all properties belonging to the element of the specified type.

Parameters:

ElementType (ObjectTypes) – Object type defined in the enum.

Returns:

List of all properties belonging to the element of type ‘ElementType’.

Return type:

list

Description:

This is a wrapper method for GetPropertyNames() from toolkit.

GetReferencesToElement(elementKey: str)

This method gets all Elements that are referencing the provided Element Key (pk/tk)

Parameters:

elementKey (str) – Pk/Tk of the element

Returns:

returns two lists, references and referencesKeys.

Return type:

tuple

Description:

This is a wrapper method for GetReferencesToElement() from toolkit

GetResultProperties_from_elementKey(elementKey: str) → list

Gets the result properties for the specified element key.

Parameters:

elementKey (str) – The element key.

Returns:

List of all result property names of an element.

Return type:

list

Description:

This is a wrapper method for GetResultProperties() from toolkit; Watch out for errors for more information.

GetResultProperties_from_elementType(elementType, onlySelectedVectors: bool) → list

Gets the result properties for the specified element type.

Parameters:

• elementType (ObjectTypes) – The element type.

• onlySelectedVectors (bool) – If True, only the names of selected vector channels for this element type shall be returned, otherwise all possible result property names for this element type shall be returned.

Returns:

List of result property names of an element type.

Return type:

list

Description:

This is a wrapper method for GetResultProperties() from toolkit; Watch out for errors for more information.

GetResultValue(elementKey: str, propertyName: str) → tuple[str, str]

Gets the result value for the given element’s property.

Parameters:

• elementKey (str) – Key of the symbol-object.

• propertyName (str) – The name of the result property.

Returns:

Value for the given element’s property and type of the value returned.

Return type:

tuple[str, str]

Description:

This is a wrapper method for GetResultValue() from toolkit; Watch out for errors for more information.

GetResultforAllTimestamp(Tk: str, property: str)

Gets the result values for a particular property of an object for all timestamps

Parameters:

• Tk (str) – Tk of the element

• property (str) – Property of the element

Returns:

resultList

Return type:

list of tuple

Description:

This is a helper function

GetResultfortimestamp(timestamp: str, Tk: str, property: str) → tuple[str, str]

Gets the result value for a particular property of an object for a specific timestamp provided as input

Parameters:

• timestamp (str) – Timestamp provided as input

• Tk (str) – Tk of the element

• property (str) – Property of the element

Returns:

(value, valueType)

Return type:

tuple[str, str]

Description:

This is a helper function

GetSimulationTimeFrame()

Retrieves the current Simulation time frame Parameters, including the time step and termination time.

Returns:

returns timeStep, terminationTime as a tuple timeStep contains the time step value for the simulation, in seconds [s] terminationTime contains the termination time for the simulation, in seconds [s]

Return type:

tuple[np.float32, np.float32]

Description:

This is a wrapper method for GetSimulationTimeFrame() from toolkit

GetTableRows(tablePkTk: str)

Gets all rows of the specified table.

Parameters:

tablePkTk (str) – Key of the table.

Returns:

List of Tk’s of all rows of the table and object type.

Return type:

tuple[list, ProviderTypes]

Description:

This is a wrapper method for GetTableRows() from toolkit; Watch out for errors for more information.

GetThermalCalculationParemeters()

Gets the current thermal Calculation Parameters

Returns:

returns activateThermalcalculation, startWithTempField, terminationPrecision, transientThermalcalculation as a tuple

Return type:

tuple[bool, bool, np.float32, bool]

Description:

This is a wrapper method for GetThermalCalculationParemeters() from toolkit

GetTimeStamps() → tuple[list, str, str, str]

Gets all available timestamps as ISO formatted strings.

Returns:

Array with all available timestamps as ISO formatted strings.

Return type:

tuple[list, str, str, str]

Description:

This is a wrapper method for GetTimeStamps() from toolkit; Watch out for errors for more information.

GetTkFromIDReference(IdRef: str, object_type) → str

Extracts the TK of an element using its ID reference.

Parameters:

• IdRef (str) – ID reference of the element.

• object_type (ObjectTypes) – Type of the element (like Node, Pipe, Valve, etc.).

Returns:

TK of the element.

Return type:

str

Description:

This is a wrapper method for GetTkFromIDReference() from toolkit; Watch out for error messages for more information.

GetTksofElementType(ElementType) → list

Gets all Tk’s belonging to the elements of the specified type.

Parameters:

ElementType (ObjectTypes) – Object type defined in the enum.

Returns:

List of all Tk’s belonging to the elements of type ‘ElementType’.

Return type:

list

Description:

This is a wrapper method for GetAllElementKeys() from toolkit.

GetValue(Tk: str, propertyName: str) → tuple[str, str]

Gets the value for the given element’s property.

Parameters:

• Tk (str) – The pk/tk of the element in question.

• propertyName (str) – Property of the element for which you want the value.

Returns:

Value and type of the value returned.

Return type:

tuple[str, str]

Description:

This is a wrapper method for GetValue() from toolkit; Watch out for error message for more information.

Reads the Value of the Property of an Element and also returns the Type name [string/float/double/int/bool] of that Property as a tuple of value and type.

GetWorkingDirectory() → str

Get the working directory currently assigned to the open model. The current User should have SIR 3S Adminitrator Role.

Returns:

The full Path of the working directory of the current Model as a string, an empty String if the operation fails.

Return type:

str

Description:

This is a wrapper method for GetWorkingDirectory() from toolkit

InsertElement(ElementType, IdRef: str) → str

Inserts a new element of the specified type.

Parameters:

• ElementType (ObjectTypes) – Object type defined in the enum to be inserted.

• IdRef (str) – Id reference.

Returns:

Tk of the element inserted.

Return type:

str

Description:

This is a wrapper method for InsertElement() from toolkit; Watch out for errors for more information.

IsMainContainer(fkCont: str) → bool

Tests if the provided Key (TK) is the Key of the main container of the model.

Parameters:

fkCont (str) – Tk of the object in question.

Returns:

Boolean value indicating if it is the main container.

Return type:

bool

Description:

This is a wrapper method for IsMainContainer() from toolkit.

NewModel(dbName: str, providerType, netType, modelDescription: str, namedInstance: str, userID: str, password: str)

Creates a new model.

Parameters:

• dbName (str) – Full path to the database file.

• providerType (ProviderTypes) – Provider type from the enum.

• netType (NetworkType) – Network type.

• modelDescription (str) – Description of the model to be created.

• namedInstance (str) – Instance name of the SQL Server.

• userID (str) – User ID for authentication, only needed for ORACLE and for SQLServer only if SQLServer authentication is required.

• password (str) – Password for authentication, only needed for ORACLE and for SQLServer only if SQLServer authentication is required.

Returns:

None

Return type:

None

Description:

This is a wrapper method for NewModel() from toolkit; Watch out for errors for more information.

OpenModel(dbName: str, providerType, Mid: str, saveCurrentlyOpenModel: bool, namedInstance: str, userID: str, password: str)

Opens a model from a database file.

Parameters:

• dbName (str) – Full path to the database file.

• providerType (ProviderTypes) – Provider type from the enum (Self.ProviderTypes).

• Mid (str) – Model identifier.

• saveCurrentlyOpenModel (bool) – Do you want to save the current model before closing it?

• namedInstance (str) – Instance name of the SQL Server.

• userID (str) – User ID for authentication, only needed for ORACLE and for SQLServer only if SQLServer authentication is required.

• password (str) – Password for authentication, only needed for ORACLE and for SQLServer only if SQLServer authentication is required.

Returns:

None

Return type:

None

Description:

This is a wrapper method for OpenModel() from toolkit; Watch out for errors for more information.

OpenModelXml(Path: str, SaveCurrentModel: bool)

Opens a model from an XML file.

Parameters:

• Path (str) – Path to XML file.

• SaveCurrentModel (bool) – Do you want to save the current model before closing it?

Returns:

None

Return type:

None

Description:

This is a wrapper method for OpenModelXml() from toolkit; Watch out for error message for more information.

RefreshViews()

Refreshes the views.

Returns:

None

Return type:

None

Description:

This is a wrapper method for RefreshViews() from toolkit; Watch out for errors for more information. Important to note is that if you open a model via python outside from SIR Graf and make changes while having the model open in SIR Graf, this function will not make changes in SIR Graf visible. To do that you need to reopen the model in SIR Graf.

SaveChanges()

Saves changes made to the model.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SaveChanges() from toolkit; Use it after End{EditSession/Transaction}. Watch out for errors for more information.

SetCalculationType(calculationType) → bool

Sets the Calculation Type for the Model. SircCalc will use this Calculation Type for the next Calculation.

Parameters:

calculationType (CalculationType) – Defined as Enum in ‘Sir3S_Repository.Interfaces’: Type of Calculation to be applied. Note: Not every Network Type supports every Calculation Type. For example, Water Networks do not support ‘Low Frequency Calculation’ and ‘Transient Calculation’. For Water and DH networks. Only SteadyState | Quasi_Stat | LowFreq | HighFreq_CHAR | HighFreq_AUTO | LoopForLoadingCondition are valid. For Gas/Steam Networks, only SteadyState | Quasi_Stat | HighFreq_CHAR | Instat_FiniteDiff | LoopForLoadingCondition are valid.

Returns:

True if the type is set; otherwise False.

Return type:

bool

Description:

This is a wrapper method for SetCalculationType() from toolkit

SetCurrentTimeStamp(timestamp: str)

Sets the current time stamp.

Parameters:

timestamp (str) – Time stamp value to be set.

Returns:

None

Return type:

None

Description:

This is a wrapper method to access the set method for the property CurrentTimestamp from toolkit.

SetElementColor(elementKey: str, color: int, fillOrLineColor: bool)

Sets the color of the specified element using an RGB integer representation.

Parameters:

• elementKey (str) – Key of the symbol-object.

• color (int) – The RGB integer representation of the color (COLORREF in GDI).

• fillOrLineColor (bool) – True if the filling color is to be set, False if only the line color is to be set.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetElementColor() from toolkit; Watch out for errors for more information.

SetElementColor_RGB(elementKey: str, red: int, green: int, blue: int, fillOrLineColor: bool)

Sets the color of the specified element using RGB values.

Parameters:

• elementKey (str) – Key of the symbol-object.

• red (int) – The R-part of the color (0…255).

• green (int) – The G-part of the color (0…255).

• blue (int) – The B-part of the color (0…255).

• fillOrLineColor (bool) – True if the filling color is to be set, False if only the line color is to be set.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetElementColor() from toolkit; Watch out for errors for more information.

SetGeometryInformation(Tk: str, Wkt: str) → bool

Sets the technical geometry information (Sachdatengeometrie) of an element using its TK.

Parameters:

• Tk (str) – TK of the element whose geometry information needs to be set.

• Wkt (str) – Geometry information to be set in the format of WKT.

Returns:

True if geometry information is set, False otherwise.

Return type:

bool

Description:

This is a wrapper method for SetGeometryInformation() from toolkit; Watch out for error messages for more information.

SetInsertPoint(elementKey: str, x: float64, y: float64)

Sets the insert point of a symbol-object.

Parameters:

• elementKey (str) – Key of the symbol-object.

• x (np.float64) – x-coordinate for the object.

• y (np.float64) – y-coordinate for the object.

Returns:

None

Return type:

None

Description:

Set the insert point of a symbol-object (e.g., Node, Valve, Tank, etc.). The insert point is the position on which the object is placed in the view.

SetLogFilePath(logFilePath: str) → bool

Sets the full Path (Drive, Directory and File Name) of the Log File

Parameters:

logFilePath (str) – The Full Path of the Log File

Returns:

isPathSet

Return type:

bool

Description:

This is a wrapper method for SetLogFilePath() from toolkit

SetSimulationTimeFrame(timeStep, terminationTime)

Sets the Simulation Time Frame for non-stationary Calculations.

Parameters:

• timeStep (np.float32) – The Time Step (Dt) of the instat. calculation in seconds [s]

• terminationTime (np.float32) – The Termination Time (total Length of the Simulation) in Seconds [s]

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetSimulationTimeFrame() from toolkit

SetThermalCalculationParemeters(activateThermalcalculation, startWithTempField, terminationPrecision, transientThermalcalculation)

Change thermal Calculation Parameters

Parameters:

• activateThermalcalculation (bool) – True to activate thermal Calculation

• startWithTempField (bool) – True for ‘Start with given Temperature Field’, False for stady-State thermal Calculation.

• terminationPrecision (np.float32) – The termination Precision ot the Thermal Calculation in [K]. Examle 0.1

• transientThermalcalculation (bool) – True if the Thermal Calculation is to be done in a transient way. This Parameter only has effect on High Frequency AUTO Calculation, HF CHAR Calculation and Low Freq. Calculation on Water and DH Networks. For more Precisions, please refer to the SirCalc Documentation.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetThermalCalculationParemeters() from toolkit

SetValue(Tk: str, propertyName: str, Value: str)

Sets the value for the given element’s property.

Parameters:

• Tk (str) – The pk/tk of the element in question.

• propertyName (str) – Property of the element for which you want to set the value.

• Value (str) – Value to be set.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetValue() from toolkit; Watch out for error message for more information.

StartEditSession(SessionName: str)

Start an edit session with the given session name.

Parameters:

SessionName (str) – A meaningful name to start a session.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for StartEditSession() from toolkit.

Recommended for fast bulk Changes (e.g. Changing the Values of 40 thousands Nodes in a single Task). Similar to StartTransaction(), EndEditSession() should be called after the Caller is done with all his bulk Changes.

StartTransaction(SessionName: str)

Start a transaction with the given session name.

Parameters:

SessionName (str) – A meaningful name to start a transaction; Empty string or None will lead to error.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for StartTransaction() from toolkit.

If Modifications on a Model are intended, it is recommended to make a Call of StartTransaction(), then do all the Modifications you need. And then call EndTransaction() as soon as you are finished with Modifications. This helps the Software to keep Track of Modifications, so the User can Undo/Redo them on the main UI (SirGraf).

WriteSirCalcXmlFile(saveItInThisDirectory) → str

Writes the SirCalc XML Input File before any Calculations are performed. This Method generates the SirCalc XML File in its initial state, allowing it to be manually edited before Calculations are executed. The SirCalc XML Input File should only be edited by people, who know what they are doing. Otherwise your calculation configuration could become deprecated. If you mess up, you can reset to the current SIR 3S model state by reexecuting WriteSirCalcXmlFile().

Parameters:

saveItInThisDirectory (str) – The Directory Path from where the SirCalc XML File should be saved. Ensure that the directory is writable. If that Path does not exist this Method shall try to create it.

Returns:

The full Path of the generated SirCalc XML Input File if the Operation succeeds; otherwise, an empty string.

Return type:

str

Description:

This is a wrapper method for WriteSirCalcXmlFile() from toolkit

to_dotnet_enum(py_enum_member)

to_python_enum(dotnet_enum_member, py_enum_type)

class sir3stoolkit.core.wrapper.SIR3S_ModelRepair(model_instance)

Bases: object

CheckRepairTool(toolName, tol, adjustnodes, nodeDegree)

Checks the said repair tool

Parameters:

• toolName (str) – Name of the tool to be executed

• tol (np.float64) – tol

• adjustnodes (bool) – adjustnodes

• nodeDegree (int) – nodeDegree

Returns:

imr

Return type:

IModelRepairMethod

Description:

This is a wrapper method for CheckRepairTool() from toolkit

ExecuteRepairTool(imr, table)

Executes the said repair tool

Parameters:

• imr (IModelRepairMethod) – IModelRepairMethod returned from CheckRepairTool()

• table (str) – intended table, e.g, “ROHR”

Returns:

None

Return type:

None

Description:

This is a wrapper method for ExecuteRepairTool() from toolkit

GetListOfRepairTool()

Fetches the list of repair tools available

Returns:

listofTool

Return type:

List

Description:

This is a wrapper method for GetListOfRepairTool() from toolkit

class sir3stoolkit.core.wrapper.SIR3S_View

Bases: object

Class definition of SIR3S_View() wrapper to access functionalities provided by SIR3S software This should be used inside python console plugin to give better control over the model for users

AddExternalArrow(x: float64, y: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, symbolFactor: float64, containerTK: str)

Adds an external arrow.

Parameters:

• x (np.float64) – x-coordinate of the arrow.

• y (np.float64) – y-coordinate of the arrow.

• lineColor (int) – Color of the arrow’s line.

• fillColor (int) – Fill color of the arrow.

• lineWidthMM (np.float64) – Width of the arrow’s line in mm.

• isFilled (bool) – Boolean indicating if the arrow is filled.

• symbolFactor (np.float64) – Symbol factor of the arrow.

• containerTK (str) – Key of the container.

Returns:

Tk of the added arrow.

Return type:

str

Description:

This is a wrapper method for AddExternalArrow() from toolkit; Watch out for errors for more information.

AddExternalEllipse(left: float64, top: float64, right: float64, bottom: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, containerTK: str) → str

Adds an external ellipse element.

Parameters:

• left (np.float64) – Left coordinate of the ellipse.

• top (np.float64) – Top coordinate of the ellipse.

• right (np.float64) – Right coordinate of the ellipse.

• bottom (np.float64) – Bottom coordinate of the ellipse.

• lineColor (int) – Color of the ellipse’s line.

• fillColor (int) – Fill color of the ellipse.

• lineWidthMM (np.float64) – Width of the ellipse’s line in mm.

• isFilled (bool) – Boolean indicating if the ellipse is filled.

• containerTK (str) – Key of the container.

Returns:

Tk of the added ellipse.

Return type:

str

Description:

This is a wrapper method for AddExternalEllipse() from toolkit; Watch out for errors for more information.

AddExternalPolygon(xArray: list, yArray: list, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, containerTK: str) → str

Adds an external polygon.

Parameters:

• xArray (list) – List of x coordinates.

• yArray (list) – List of y coordinates.

• lineColor (int) – Color of the polygon’s line.

• fillColor (int) – Fill color of the polygon.

• lineWidthMM (np.float64) – Width of the polygon’s line in mm.

• isFilled (bool) – Boolean indicating if the polygon is filled.

• containerTK (str) – Key of the container.

Returns:

Tk of the added polygon.

Return type:

str

Description:

This is a wrapper method for AddExternalPolygon() from toolkit; Watch out for errors for more information.

AddExternalPolygonPoint(Tk: str, x: float64, y: float64)

Adds a point to an external polygon.

Parameters:

• Tk (str) – Key of the polygon.

• x (np.float64) – x-coordinate of the point.

• y (np.float64) – y-coordinate of the point.

Returns:

None

Return type:

None

Description:

This is a wrapper method for AddExternalPolygonPoint() from toolkit; Watch out for errors for more information.

AddExternalPolygon_using_LineString(wktLineString: str, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, containerTK: str) → str

Adds an external polygon using linestring.

Parameters:

• wktLineString (str) – A string with all Points for Geometry in WKT Format i.e formatted like ‘LINESTRING (120 76 0, 500 300 0, 620 480 0, 364 276 0, 120 76 0)’. THE LAST POINT SHOULD BE IDENTICAL TO THE FIRST POINT

• lineColor (int) – Color of the polygon’s line.

• fillColor (int) – Fill color of the polygon.

• lineWidthMM (np.float64) – Width of the polygon’s line in mm.

• isFilled (bool) – Boolean indicating if the polygon is filled.

• containerTK (str) – Key of the container.

Returns:

Tk of the added polygon.

Return type:

str

Description:

This is a wrapper method for AddExternalPolygon() from toolkit; Watch out for errors for more information.

AddExternalPolyline(xArray: list, yArray: list, iColor: int, lineWidthMM: float64, dashedLine: bool, containerTK: str) → str

Adds an external polyline.

Parameters:

• xArray (list) – List of x coordinates.

• yArray (list) – List of y coordinates.

• iColor (int) – Color of the polyline.

• lineWidthMM (np.float64) – Width of the polyline in mm.

• dashedLine (bool) – Boolean indicating if the polyline is dashed.

• containerTK (str) – Key of the container.

Returns:

Tk of the added polyline.

Return type:

str

Description:

This is a wrapper method for AddExternalPolyline() from toolkit; Watch out for errors for

more information.

AddExternalPolylinePoint(Tk: str, x: float64, y: float64)

Adds a point to an external polyline.

Parameters:

• Tk (str) – Key of the polyline.

• x (np.float64) – x-coordinate of the point.

• y (np.float64) – y-coordinate of the point.

Returns:

None

Return type:

None

Description:

This is a wrapper method for AddExternalPolylinePoint() from toolkit; Watch out for errors for more information.

AddExternalPolyline_using_LineString(wktLineString: str, iColor: int, lineWidthMM: float64, dashedLine: bool, containerTK: str) → str

Adds an external polyline using linestring.

Parameters:

• wktLineString (str) – A string with all Points for Geometry in WKT Format i.e formatted like ‘LINESTRING (120 76 0, 500 300 0, 620 480 0, 364 276 0)’.

• iColor (int) – Color of the polyline.

• lineWidthMM (np.float64) – Width of the polyline in mm.

• dashedLine (bool) – Boolean indicating if the polyline is dashed.

• containerTK (str) – Key of the container.

Returns:

Tk of the added polyline.

Return type:

str

Description:

This is a wrapper method for AddExternalPolyline() from toolkit; Watch out for errors for more information.

AddExternalRectangle(left: float64, top: float64, right: float64, bottom: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, isRounded: bool, containerTK: str)

Adds an external rectangle element.

Parameters:

• left (np.float64) – Left coordinate of the rectangle.

• top (np.float64) – Top coordinate of the rectangle.

• right (np.float64) – Right coordinate of the rectangle.

• bottom (np.float64) – Bottom coordinate of the rectangle.

• lineColor (int) – Color of the rectangle’s line.

• fillColor (int) – Fill color of the rectangle.

• lineWidthMM (np.float64) – Width of the rectangle’s line in mm.

• isFilled (bool) – Boolean indicating if the rectangle is filled.

• isRounded (bool) – Boolean indicating if the rectangle is rounded.

• containerTK (str) – Key of the container.

Returns:

Tk of the added rectangle.

Return type:

str

Description:

This is a wrapper method for AddExternalRectangle() from toolkit; Watch out for errors for more information.

AddExternalText(x: float64, y: float64, textColor: int, text: str, angleDegree: float32, heightPt: float32, isBold: bool, isItalic: bool, isUnderline: bool, containerTK: str)

Adds external text.

Parameters:

• x (np.float64) – x-coordinate of the text.

• y (np.float64) – y-coordinate of the text.

• textColor (int) – Color of the text.

• text (str) – The text content.

• angleDegree (np.float32) – Angle of the text in degrees.

• heightPt (np.float32) – Height of the text in points.

• isBold (bool) – Boolean indicating if the text is bold.

• isItalic (bool) – Boolean indicating if the text is italic.

• isUnderline (bool) – Boolean indicating if the text is underlined.

• containerTK (str) – Key of the container.

Returns:

Tk of the added text.

Return type:

str

Description:

This is a wrapper method for AddExternalText() from toolkit; Watch out for errors for more information.

AddNewCustomer(x: float64, y: float64, z: float32, symbolFactor: float64, fkHouse: str, consumption: float64, counterId: str, customerId: str, dimension: str, divisionType: str, customerGroup: str, idRef: str) → str

Method for inserting a new Customer within the main Container of the Model

Parameters:

• x (np.float64) – Absolute x-Coordinate of the Customer

• y (np.float64) – Absolute y-Coordinate of the Customer

• z (np.float32) – Absolute z-Coordinate of the Customer

• symbolFactor (np.float64) – The Symbol Factor

• fkHouse (str) – The tk (Key) of the House the Customer is attached to (or empty String or ‘-1’ if none)

• consumption (np.float64) – Consumption Value Q0 (NODE) or W0 (DH-Consumer). The consumption Value can have different Dimensions.In Water usually Qa - i.e. [m^3/ a]. In Gas[Nm^3/ a]. In heat, it is usually a power in [kW] or[MW].

• counterId (str) – ID point of consumption (from reference data for identification). max 40 Characters

• customerId (str) – ID of the Customer who is the contractual Partner of the CC for this point of consumption (from reference data for identification). max 40 Characters

• dimension (str) – Dimension of consumption m3/a, Nm3/a, kW, kWh, MW or MWh, max 12 Characters

• divisionType (str) – Division type, max 12 Characters ( should be ‘W-’, ‘W+’, ‘F-’, ‘G-’ or ‘K-’ depending on Netrworkm type); W- = consumer in the water network (outflow); W+ = “consumer” in the collection network (inflow); F- = consumer in the district heating network (W0); G- = consumer in the gas network (outflow); K- = consumer in the refrigeration network;

• customerGroup (str) – Name of Customer Group, just to differenciate Customers, max 80 Characters

• idRef (str) – ID n Reference System, max 40 Characters

Returns:

returns the TK of the newly inserted Customer, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewCustomer() from toolkit; Watch out for errors for more information.

AddNewDirectionalArrow(tkCont: str, x: float64, y: float64, lineColor: int, lineWidth: float64, fillColor: int, isFilled: bool, symbolFactor: float64, description: str, tkObserved: str, elemResultProperty: str, EPS: float32)

Adds an external arrow.

Parameters:

• tkCont (str) – The (tk) key of the Container

• x (np.float64) – x-coordinate of the directional arrow.

• y (np.float64) – y-coordinate of the directional arrow.

• lineColor (int) – Color of the directional arrow’s line.

• lineWidth (np.float64) – Width of the arrow’s line in mm.

• fillColor (int) – Fill color of the arrow.

• isFilled (bool) – Boolean indicating if the arrow is filled.

• symbolFactor (np.float64) – Symbol factor of the arrow.

• description (str) – The Description, max 254 Characters

• tkObserved (str) – The Tk (key) of the Element this array shall be bound to

• elemResultProperty (str) – The Property Name of a Result on the bound Element

• EPS (np.float32) – Display Tolerance. Arrow direction is only displayed if the absolute value of the data point Result value is greater than the specified tolerance

Returns:

Tk of the added directional arrow.

Return type:

str

Description:

This is a wrapper method for AddNewDirectionalArrow() from toolkit; Watch out for errors

for more information.

AddNewHouse(x: float64, y: float64, symbolFactor: float64, fkStreet: str, houseNumber: int, numberSuffix: int, postalCode: int, dsn: str, fkNode: str, fkDH_Customer: str, idRef: str)

Method for inserting a new House within the main Container of the Model

Parameters:

• x (np.float64) – Absolute x-Coordinate of the House

• y (np.float64) – Absolute y-Coordinate of the House

• symbolFactor (np.float64) – The Symbol Factor

• fkStreet (str) – The tk (Key) of the Street if any (or just an emty String ot ‘-1’ if none)

• houseNumber (int) – The House number

• numberSuffix (int) – The house Number Suffix, max. 40 characters

• postalCode (int) – The Postal Code

• dsn (str) – The official Number of the Street (if known), max. 80 Characters

• fkNode (str) – Only for non-District Heating Networks: The tk (key) of the Node connected to the House (if any)

• fkDH_Customer (str) – Only for District Heating Networks: The tk (key) of the DH Consumer connected to the House (if any)

• idRef (str) – User-defined Reference ID

Returns:

returns the TK of the newly inserted House, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewHouse() from toolkit; Watch out for errors for more information.

AddNewHydrant(x: float64, y: float64, z: float64, iType, symbolFactor: float64, fkNode: str, L: float32, dn: float32, roughness: float32, ph_min: float32, ph_soll: float32, qm_soll, activity, idRef: str, name: str, description: str)

Method for inserting a new Customer within the main Container of the Model

Parameters:

• x (np.float64) – The X-Coordinate of the Hydrant

• y (np.float64) – The Y-Coordinate of the Hydrant

• z (np.float32) – The Z-Coordinate of the Hydrant

• iType (Hydrant_Type) – Type of Hydrant. Possible Value are: 1 = Subsurface 11 = Surface

• symbolFactor (np.float64) – The Symbol Factor

• fkNode (str) – The tk (key) of a Node within the main Comntainer if the Hydrant is attached to a Node

• L (np.float32) – Length of the Connection Pipe

• dn (np.float32) – Nominal Diameter of the Hydrant in [mm]

• roughness (np.float32) – Roughness coefficient (k-value) Connecting pipe

• ph_min (np.float32) – Minimum pressure at the tapping point

• ph_soll (np.float32) – Set pressure at the binding point

• qm_soll (Hydrant_QM_SOLL) – Target extraction quantity

• activity (Hydrant_Activity) – Activity status (0=inactive | 1=calculated in the extinguishing water plugin | 2=calculated)

• idRef (str) – Reference ID

• name (str) – Name of the Hydrant, max 40 Characters

• description (str) – Description, max 254 Characters

Returns:

returns the TK of the newly inserted Hydrant, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewHydrant() from toolkit; Watch out for errors for more information.

AddNewNumericalDisplay(tkCont: str, x: float64, y: float64, color: int, angle_degree: float32, faceName: str, heightPt: float32, isBold: bool, isItalic: bool, isUnderlined: bool, description: str, forResult: bool, tkObserved: str, elemPropertyNameOrResult: str, prefix: str, unit: str, numDec: int, absValue: bool) → str

Method for inserting a new numerical Display into a Container

Parameters:

• tkCont (str) – The (tk) key of the Container to insert the numerical Display in

• x (np.float64) – Absolute x-Coordinate of the numerical Displa (left)

• y (np.float64) – Absolute y-Coordinate of the numerical Displa (bottom)

• color (int) – The desired Color as RGB

• angle_degree (np.float32) – Angle in Degree

• faceName (str) – Face Name of the Font (max. 32 Characters). Entering a non-installed Face Name will assume it to be ‘Arial’

• heightPt (np.float32) – The height in Point

• isBold (bool) – True if the Font should be bold

• isItalic (bool) – True if the Font should be italic

• isUnderlined (bool) – True if the Font should be underlined

• description (str) – Description of Text. Max 254 Characters

• forResult (bool) – True if it should display a Calculation Result of an Element, False if it should display an Element Property

• tkObserved (str) – The tk (Key) of the Element observed by this num. Display

• elemPropertyNameOrResult (str) – a String representing the Result-Property or the Element Property Name, depending on Parameter ‘forResult’. eg. “L” if a Pipe Length is observed or “QMAV” for the Result ‘Average Flow Rate’ on Pipe.

• prefix (str) – Prefix (precedes the Text), max. 80 Characters

• unit (str) – User-defined Unit, max. 80 Characters

• numDec (str) – Number of Decimals Digits

• absValue (bool) – True if a absolute Value should be displayed

Returns:

The TK of the newly inserted numerical display, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewNumericalDisplay() from toolkit; Watch out for errors for more information.

AddNewStreet(name: str, number: str, place: str, district: str, idref: str) → str

Method for adding a new Street

Parameters:

• name (str) – Street Name, max. 80 Characters

• number (str) – Street Number, max. 80 characters (it may be a official Number)

• place (str) – The name of the Place hosting the Street, max. 80 characters

• district (str) – The name of the District under the Place, max. 80 characters

• idref (str) – Reference ID, max. 40 characters

Returns:

returns the TK of the newly inserted Street, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewStreet() from toolkit; Watch out for errors for more information.

AddNewText(tkCont: str, x: float64, y: float64, color: int, textContent: str, angle_degree: float32, faceName: str, heightPt: float32, isBold: bool, isItalic: bool, isUnderlined: bool, idRef: str, description: str) → str

Method for inserting a new Text within a Container

Parameters:

• tkCont (str) – The (tk) key of the Container to insert the Text in

• x (np.float64) – Absolute x-Coordinate of the Text (left)

• y (np.float64) – Absolute y-Coordinate of the Text (bottom)

• color (int) – The desired Color as RGB

• textContent (str) – The textual Content of the Text. Max 80 Characters

• angle_degree (np.float32) – Angle in Degree

• faceName (str) – Face Name of the Font (max. 32 Characters). Entering a non-installed Face Name will assume it to be ‘Arial’

• heightPt (np.float32) – The height in Point

• isBold (bool) – True if the Font should be bold

• isItalic (bool) – True if the Font should be italic

• isUnderlined (bool) – True if the Font should be underlined

• idRef (str) – user-defined Reference ID. Max 40 Characters

• description (str) – Description of Text. Max 254 Characters

Returns:

The TK of the newly inserted Text, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewText() from toolkit; Watch out for errors for more information.

AddNewValveOnPipe(tkPipe: str, iSymbolType, position: float32, name: str, description: str, isPostureStatic, fkSWVT: str, openClose: bool, idRef: str)

Insert a new Net Valve of Pipe. If the Pipe does’nt lie on the main Container, nothing shall be done.

Parameters:

• tkPipe (str) – The tk (key) of the Pipe

• iSymbolType (NetValveTypes) – Symbol Type: Possible values are: 1 = Gate Valve 2 = Flap Valve 3 = Plug Valve

• position (np.float32) – Position on Pipe: Possible Values are: 0 = at the Beginning of the Pipe (by Node Ki) -1 = at the End of the Pipe (by Node Kk) -2 = at the Middle of the Pipe or every Value in the interval [0, L] where L is the technical Length of the Pipe.

• name (str) – A Name for the Valve, max 40 Characters

• description (str) – Description of the Valve, max 254 Characters

• isPostureStatic (NetValvePostures) – Option if the Posture is statically open/closed or time depemdant. Enter NetValvePostures.STATIC_OPEN_CLOSE if Posture is always open / closed otherwise enter NetValvePostures.TIME_DEP_TABLE if the Posture depends on a Setpoint Table (SWVT)

• fkSWVT (str) – the pk (key) of the SetPoint Table, in Case the Parameter ‘isPostureStatic’ is entered as NetValvePostures.TIME_DEP_TABLE

• openClose (bool) – Only usable in Case the Parameter ‘isPostureStatic’ is entered as NetValvePostures. STATIC_OPEN_CLOSE. So entering in that case ‘True’, resp. ‘False’ assumes the Valve is always open resp. closed.

• idRef (str) – Reference ID, max 40 Characters

Returns:

returns the TK of the newly inserted Valve, otherwise ‘-1’.

Return type:

str

Description:

This is a wrapper method for AddNewValveOnPipe() from toolkit; Watch out for errors for more information.

CloseModel(saveChangesBeforeClosing: bool) → bool

Closes a currently open Model.

Parameters:

saveChangesBeforeClosing (bool) – If True, the Changes would be saved before Closing otherwise Changes would be discarded

Returns:

return True if model is successfully closed, False otherwise

Return type:

bool

Description:

This is a wrapper method for CloseModel() from toolkit; Watch out for errors for more information.

ColoratePipe(Tk: str, lengths: list, Colors: list, widthFactors: list)

Colorates pipe with specified lengths, colors and width factors.

Parameters:

• Tk (str) – Key of pipe element.

• lengths (list) – List of lengths to colorate pipe with.

• Colors (list) – List of colors to colorate pipe with.

• widthFactors (list) – List of width factors to colorate pipe with.

Returns:

None

Return type:

None

Description:

This is a wrapper method for ColoratePipe() from toolkit; Watch out for errors for more information.

DoColoration()

Performs coloration of elements.

Returns:

None

Return type:

None

Description:

This is a wrapper method for DoColoration() from toolkit; Watch out for errors for more information.

EnableOrDisableOutputComments(outputComments: bool)

Enable or disable additional output comments while using methods from SIR3S_Model class. These comments could help you understand about the positive outcome of a method. Default value is True

Parameters:

outputComments (bool) – To enable pass true and to disable pass false

Returns:

None

Return type:

None

Description:

This is a helper function

EndEditSession()

End the current edit session.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for EndEditSession() from toolkit. Use it after StartEditSession() to close that session.

EndTransaction()

End the current transaction.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for EndTransaction() from toolkit. Use it after StartTransaction() to close that transaction.

GetColor(valMin: float64, valMax: float64, val: float64) → tuple[int, int]

Gets color corresponding to specified value within range defined by minimum and maximum values.

Parameters:

• valMin (np.float64) – Minimum value in range.

• valMax (np.float64) – Maximum value in range.

• val (np.float64) – Value to get color for within range defined by min and max values.

Returns:

Color corresponding to specified value within range defined by min and max values and index of color in table.

Return type:

tuple[int, int]

Description:

This is a wrapper method for GetColor() from toolkit; Watch out for errors for more information.

GetColorTableEntries(result_i: float64, result_k: float64, scaleMin: float64, scaleMax: float64) → list

Gets color table entries.

Parameters:

• result_i (np.float64) – Result i value.

• result_k (np.float64) – Result k value.

• scaleMin (np.float64) – Minimum scale value.

• scaleMax (np.float64) – Maximum scale value.

Returns:

List of color table entries.

Return type:

list

Description:

This is a wrapper method for GetColorTableEntries() from toolkit; Watch out for errors for more information.

GetFont(Tk: str) → fontInformation

Method for getting font related information

Parameters:

Tk (str) – The tk (key) of the Element

Returns:

return all the properties bundled in a namedtuple ‘fontInformation’

Return type:

fontInformation

Description:

This is a wrapper method for GetFont() from toolkit; Watch out for errors for more information.

GetMainContainer()

Finds the main container of the model and returns its Key (TK).

Returns:

Tk of the main container and object type.

Return type:

tuple[str, ObjectTypes]

Description:

This is a wrapper method for GetMainContainer() from toolkit; Finds the Main Container of the Model and returns its Key (TK).

GetMarkedElements(tkCONT)

Retrieves a list of all Elements marked within the Container with TK = tkCONT. Enter “-1” if you want to retrieve all marked Elements in ALL Views(Containers). If a Connection Line is marked, the main part of the Element is also returned in the List.

Parameters:

tkCONT (str) – A token used to identify and filter the marked elements. Cannot be null or empty.

Returns:

A list of strings representing the marked elements. Returns an empty list if no elements are found.

Return type:

list

Description:

This is a wrapper method for GetMarkedElements() from toolkit

GetNumericalDisplayProperties(Tk: str) → numericalDisplayProperties

Method for getting Properties of a numerical display

Parameters:

Tk (str) – The tk (key) of the Element

Returns:

return all the properties bundled in a namedtuple ‘numericalDisplayProperties’

Return type:

numericalDisplayProperties

Description:

This is a wrapper method for GetNumericalDisplayProperties() from toolkit; Watch out for errors for more information.

GetTextProperties(Tk: str) → textProperties

Method for getting Properties of a Text

Parameters:

Tk (str) – The tk (key) of the Element

Returns:

return all text properties bundled in a namedtuple ‘textProperties’

Return type:

textProperties

Description:

This is a wrapper method for GetTextProperties() from toolkit; Watch out for errors for more information.

GetWidthFactor(actualValue: float64) → float64

Gets width factor corresponding to specified actual value.

Parameters:

actualValue (np.float64) – Value to get width factor for.

Returns:

Width factor corresponding to specified actual value.

Return type:

np.float64

Description:

This is a wrapper method for GetWidthFactor() from toolkit; Watch out for errors for more information.

InitColorTable(iColors: list, maxColors: int) → bool

Initializes color table with specified colors and maximum colors.

Parameters:

• iColors (list) – List of colors to initialize table with.

• maxColors (int) – Maximum number of colors in table.

Returns:

Boolean indicating if color table was initialized successfully.

Return type:

bool

Description:

This is a wrapper method for InitColorTable() from toolkit; Watch out for errors for more information.

IsElementMarked(tk) → bool

Determines whether the specified element (OR any of its Connection Lines) is marked based on the provided Key.

Parameters:

tk (str) – The Key of the Element

Returns:

True if the element is marked; otherwise False.

Return type:

bool

Description:

This is a wrapper method for IsElementMarked() from toolkit

MarkElement(tk) → bool

Marks an element AND ALL its connection Lines

Parameters:

tk (str) – The token used to identify the element to be marked. Cannot be null or empty.

Returns:

True if the element was successfully marked; otherwise False.

Return type:

bool

Description:

This is a wrapper method for MarkElement() from toolkit

MoveElementBy(Tk: str, dX: float64, dY: float64)

General Method for moving an Object by a defined (relative) Amount. This Method only applies to both Symbol-Objects (incl. Texts) and also to Line Objects such as Pipes, Polylines, Polygones. Calling this Method on a Pipe would also move the both End Nodes of the Pipe.

Parameters:

• Tk (str) – The tk (key) of the Element

• dX (np.float64) – The Amount of Translation in X-Direction

• dY (np.float64) – The Amount of Translation in Y-Direction

Returns:

None

Return type:

None

Description:

This is a wrapper method for MoveElementBy() from toolkit; Watch out for errors for more information.

MoveElementTo(Tk: str, newX: float64, newY: float64)

General Method for moving an Object to a specified ABSOLUTE Location. This Method only applies to Symbol-Objects (and Texts). Thus Calling it on Line Objects such as Pipes, Polylines, Polygones has no effect.

Parameters:

• Tk (str) – The tk (key) of the Element

• newX (np.float64) – New absolute X-Position

• newY (np.float64) – New absolute Y-Position

Returns:

None

Return type:

None

Description:

This is a wrapper method for MoveElementTo() from toolkit; Watch out for errors for more information.

OpenModel(dbName: str, providerType, Mid: str, saveCurrentlyOpenModel: bool, namedInstance: str, userID: str, password: str)

Opens a model from a database file.

Parameters:

• dbName (str) – Full path to the database file.

• providerType (ProviderTypes) – Provider type from the enum.

• Mid (str) – Model identifier.

• saveCurrentlyOpenModel (bool) – Do you want to save the current model before closing it?

• namedInstance (str) – Instance name of the SQL Server.

• userID (str) – User Id for Authentication, only needed for ORACLE and for SQLServer only if SQLServer Authentication is required.

• password (str) – Password for Authentication, only needed for ORACLE and for SQLServer Authentication is required.

Returns:

None

Return type:

None

Description:

This is a wrapper method for openModel() from toolkit; Watch out for errors for more information.

OpenModelXml(Path: str, SaveCurrentModel: bool)

Opens a model from an XML file.

Parameters:

• Path (str) – Path to XML file.

• SaveCurrentModel (bool) – Do you want to save the current model before closing it?

Returns:

None

Return type:

None

Description:

This is a wrapper method for OpenModelXml() from toolkit; Watch out for error message for more information.

PrepareColoration()

Prepares coloration for elements.

Returns:

None

Return type:

None

Description:

This is a wrapper method for PrepareColoration() from toolkit; Watch out for errors for more information.

RefreshViews()

Refreshes the views.

Returns:

None

Return type:

None

Description:

This is a wrapper method for RefreshViews() from toolkit; Watch out for errors for more information.

RemoveAllExternalVisualObjects()

Removes all External Visual Objects (external Polygones, Ellipses, Polylines, Arrows, Circles Texts) from the Model and eventually refresh Views.

Returns:

None

Return type:

None

Description:

This is a wrapper method for RemoveAllExternalVisualObjects() from toolkit

ResetColoration()

Resets coloration of elements.

Returns:

None

Return type:

None

Description:

This is a wrapper method for ResetColoration() from toolkit; Watch out for errors for more information.

SaveChanges()

Saves changes made to the model.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SaveChanges() from toolkit; Use it after End{EditSession/Transaction}. Watch out for errors for more information.

SetExternalArrowProperties(Tk: str, x: float64, y: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, symbolFactor: float64)

Sets properties of an external arrow element.

Parameters:

• Tk (str) – Key of the arrow element.

• x (np.float64) – x-coordinate of the arrow element.

• y (np.float64) – y-coordinate of the arrow element.

• lineColor (int) – Color of the arrow’s line.

• fillColor (int) – Fill color of the arrow element.

• lineWidthMM (np.float64) – Width of the arrow’s line in mm.

• isFilled (bool) – Boolean indicating if the arrow element is filled.

• symbolFactor (np.float64) – Symbol factor of the arrow element.

Returns:

None

Return type:

None

Description:

This is a wrapper method for AddExternalArrow() from toolkit; Watch out for errors for more information.

SetExternalEllipseProperties(Tk: str, left: float64, top: float64, right: float64, bottom: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool)

Sets properties of an external ellipse element.

Parameters:

• Tk (str) – Key of the ellipse element.

• left (np.float64) – Left coordinate of the ellipse.

• top (np.float64) – Top coordinate of the ellipse.

• right (np.float64) – Right coordinate of the ellipse.

• bottom (np.float64) – Bottom coordinate of the ellipse.

• lineColor (int) – Color of the ellipse’s line.

• fillColor (int) – Fill color of the ellipse.

• lineWidthMM (np.float64) – Width of the ellipse’s line in mm.

• isFilled (bool) – Boolean indicating if the ellipse is filled.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetExternalEllipseProperties() from toolkit; Watch out for errors for more information.

SetExternalPolyLineWidthAndColor(Tk: str, lineWidthMM: float64, iColor: int)

Sets the width and color of an external polyline.

Parameters:

• Tk (str) – Key of the polyline.

• lineWidthMM (np.float64) – Width of the polyline in mm.

• iColor (int) – Color of the polyline.

Returns:

None

Return type:

None

Description:

This is a wrapper method for AddExternalPolylinePoint() from toolkit; Watch out for errors for more information.

SetExternalPolygonProperties(Tk: str, lineWidthMM: float64, lineColor: int, fillColor: int, isFilled: bool)

Sets properties of an external polygon.

Parameters:

• Tk (str) – Key of the polygon.

• lineWidthMM (np.float64) – Width of the polygon’s line in mm.

• lineColor (int) – Color of the polygon’s line.

• fillColor (int) – Fill color of the polygon.

• isFilled (bool) – Boolean indicating if the polygon is filled.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetExternalPolygonProperties() from toolkit; Watch out for errors for more information.

SetExternalRectangleProperties(Tk: str, left: float64, top: float64, right: float64, bottom: float64, lineColor: int, fillColor: int, lineWidthMM: float64, isFilled: bool, isRounded: bool)

Sets properties of an external rectangle element.

Parameters:

• Tk (str) – Key of the rectangle element.

• left (np.float64) – Left coordinate of the rectangle.

• top (np.float64) – Top coordinate of the rectangle.

• right (np.float64) – Right coordinate of the rectangle.

• bottom (np.float64) – Bottom coordinate of the rectangle.

• lineColor (int) – Color of the rectangle’s line.

• fillColor (int) – Fill color of the rectangle.

• lineWidthMM (np.float64) – Width of the rectangle’s line in mm.

• isFilled (bool) – Boolean indicating if the rectangle is filled.

• isRounded (bool) – Boolean indicating if the rectangle is rounded.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetExternalRectangleProperties() from toolkit; Watch out for errors for more information.

SetExternalTextProperties(Tk: str, x: float64, y: float64, textColor: int, text: str, angleDegree: float32, heightPt: float32, isBold: bool, isItalic: bool, isUnderline: bool)

Sets properties of an external text element.

Parameters:

• Tk (str) – Key of the text element.

• x (np.float64) – x-coordinate of the text.

• y (np.float64) – y-coordinate of the text.

• textColor (int) – Color of the text.

• text (str) – The text content.

• angleDegree (np.float32) – Angle of the text in degrees.

• heightPt (np.float32) – Height of the text in points.

• isBold (bool) – Boolean indicating if the text is bold.

• isItalic (bool) – Boolean indicating if the text is italic.

• isUnderline (bool) – Boolean indicating if the text is underlined.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetExternalTextProperties() from toolkit; Watch out for errors for more information.

SetExternalTextText(Tk: str, text: str)

Sets the text of an external text element.

Parameters:

• Tk (str) – Key of the text element.

• text (str) – The text content.

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetExternalTextText() from toolkit; Watch out for errors for more information.

SetFont(Tk: str, textContent: str, color: int, angle_degree: float32, faceName: str, heightPt: float32, isBold: bool, isItalic: bool, isUnderlined: bool)

Sets the Font on a Element that has Font. This Method only applies to Texts, numerical Displays, Block Symbols and Block References.

Parameters:

• Tk (str) – The tk (key) of the Element which Font has to be retrieved

• color (int) – The desired Color as RGB

• textContent (str) – Only has Effect on TEXTs

• angle_degree (np.float32) – Text angle

• faceName (str) – Face Name of the Font

• heightPt (np.float32) – The height in Point

• isBold (bool) – True if the Font should be bold

• isItalic (bool) – True if the Font should be italic

• isUnderlined (bool) – True if the Font should be underlined

Returns:

None

Return type:

None

Description:

This is a wrapper method for SetFont() from toolkit; Watch out for errors for more information.

SetWidthScaleProperties(valMin: float64, widthMin: float64, valMax: float64, widthMax: float64) → bool

Sets width scale properties.

Parameters:

• valMin (np.float64) – Minimum value.

• widthMin (np.float64) – Minimum width.

• valMax (np.float64) – Maximum value.

• widthMax (np.float64) – Maximum width.

Returns:

Boolean indicating if width scale properties were set successfully.

Return type:

bool

Description:

This is a wrapper method for SetWidthScaleProperties() from toolkit; Watch out for errors for more information.

StartEditSession(SessionName: str)

Start an edit session with the given session name.

Parameters:

SessionName (str) – A meaningful name to start a session.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for StartEditSession() from toolkit.

StartTransaction(SessionName: str)

Start a transaction with the given session name.

Parameters:

SessionName (str) – A meaningful name to start a transaction; Empty string or None will lead to error.

Returns:

None

Return type:

None

Description:

This method is a wrapper method for StartTransaction() from toolkit.

UnmarkAll(tkCONT) → bool

Unmarks all Elements within the Container with TK = tkCONT. If tkCONT = “-1”, all Elements in ALL Views(Containers) are unmarked. Unmarking an Element also unmarks all its Connection Lines.

Parameters:

tkCONT (str) – The TK of the Container, which all Elements should be unmarked. Enter “-1” if yow want to unmark the whole Model

Returns:

True if everything went OK, otherwise False.

Return type:

bool

Description:

This is a wrapper method for UnmarkAll() from toolkit

UnmarkElement(tk) → bool

Unmarks the Element and ALL its Connection Lines

Parameters:

tk (str) – The Key of the Element

Returns:

True if everything went OK, otherwise False.

Return type:

bool

Description:

This is a wrapper method for UnmarkElement() from toolkit

to_dotnet_enum(py_enum_member, py_enum_type)

to_python_enum(dotnet_enum_member, py_enum_type)

sir3stoolkit.core.wrapper.Write_SirGraf_Config_Path(basePath: str) → None

Write the SirGraf directory path to the package’s config file.

The path is validated to exist and then written to config.txt in the package root directory (sir3stoolkit/config.txt), normalized to forward slashes (e.g. C:/3S/SIR 3S/SirGraf-90-15-00-24_Quebec-Upd2) to avoid backslash-related issues seen in the host application. If config.local.txt is already present in that directory (developer override), the path is written there instead.

Parameters:

basePath (str) – Full path to the SirGraf directory to persist.

Raises:

FileNotFoundError – If basePath does not exist or is not a directory.

Returns:

None

Return type:

None

sir3stoolkit.core.wrapper.create_dotnet_enum(name: str, dotnet_enum: str, assembly_ext: str)

class sir3stoolkit.core.wrapper.fontInformation(textContent, color, angle_degree, faceName, heightPt, isBold, isItalic, isUnderline)

Bases: tuple

angle_degree

Alias for field number 2

color

Alias for field number 1

faceName

Alias for field number 3

heightPt

Alias for field number 4

isBold

Alias for field number 5

isItalic

Alias for field number 6

isUnderline

Alias for field number 7

textContent

Alias for field number 0

class sir3stoolkit.core.wrapper.hydraulicProfile(childrenUID, nodesVL, linksVL, xVL, nodesRL, linksRL, xRL, nrOfBranches, xOffSet, xOffsetRelativeToParent, length, tkArticulationNode)

Bases: tuple

childrenUID

Alias for field number 0

length

Alias for field number 10

linksRL

Alias for field number 5

linksVL

Alias for field number 2

nodesRL

Alias for field number 4

nodesVL

Alias for field number 1

nrOfBranches

Alias for field number 7

tkArticulationNode

Alias for field number 11

xOffSet

Alias for field number 8

xOffsetRelativeToParent

Alias for field number 9

xRL

Alias for field number 6

xVL

Alias for field number 3

class sir3stoolkit.core.wrapper.numericalDisplayProperties(x, y, color, angle_degree, faceName, heightPt, isBold, isItalic, isUnderline, description, forResult, tkObserved, elemPropertyNameOrResult, prefix, unit, numDec, absValue)

Bases: tuple

absValue

Alias for field number 16

angle_degree

Alias for field number 3

color

Alias for field number 2

description

Alias for field number 9

elemPropertyNameOrResult

Alias for field number 12

faceName

Alias for field number 4

forResult

Alias for field number 10

heightPt

Alias for field number 5

isBold

Alias for field number 6

isItalic

Alias for field number 7

isUnderline

Alias for field number 8

numDec

Alias for field number 15

prefix

Alias for field number 13

tkObserved

Alias for field number 11

unit

Alias for field number 14

x

Alias for field number 0

y

Alias for field number 1

class sir3stoolkit.core.wrapper.textProperties(x, y, color, textContent, angle_degree, faceName, heightPt, isBold, isItalic, isUnderline, idRef, description)

Bases: tuple

angle_degree

Alias for field number 4

color

Alias for field number 2

description

Alias for field number 11

faceName

Alias for field number 5

heightPt

Alias for field number 6

idRef

Alias for field number 10

isBold

Alias for field number 7

isItalic

Alias for field number 8

isUnderline

Alias for field number 9

textContent

Alias for field number 3

x

Alias for field number 0

y

Alias for field number 1

Mantle

Created on Fri Aug 29 09:22:31 2025

This module implements interactions between SIR 3S and pandas dataframes. You can obtain pandas dfs with model- or resultdata, insert nodes and pipes via a df, etc.

@author: Jablonski

class sir3stoolkit.mantle.dataframes.SIR3S_Model_Dataframes

Bases: SIR3S_Model

This class is supposed to extend the general SIR3S_Model class with the possibility of using pandas dataframes when working with SIR 3S. Getting dataframes, inserting elements via dataframes, running algorithms on dataframes should be made possible.

add_interior_points_as_flat_cols(df)

Expand tab-separated vector columns (name contains “VEC”) into *_0..*_N-1 columns. Non-VEC columns remain unchanged.

Parameters:

df (pd.DataFrame) – Input DataFrame with scalar columns and VEC columns containing tab-separated strings.

Returns:

DataFrame with new numeric columns for each interior point.

Return type:

pd.DataFrame

Description:

This method processes the result DataFrame by expanding tab-separated vector-valued properties (typically from pipes) into properly structured numerical segments. Each vector entry becomes a new column.

add_interior_points_as_multiindex(df_results)

Expand vector properties from tab-separated strings into multiple interior-point segments along a new MultiIndex column level.

Vector properties are identified by having ‘VEC’ in the last column-level name. Their tab-separated string values are split into float segments representing interior points along the device. Non-vector properties have their interior point index set to -1 and retain their scalar values.

Parameters:

df_results (pd.DataFrame) – Results DataFrame containing scalar and vector properties.

Returns:

A DataFrame in which vector properties are expanded along a new MultiIndex level named ‘interior points’, with float values for each interior segment. Non-vector properties are assigned interior point -1.

Return type:

pd.DataFrame

Description:

This method processes the result DataFrame by expanding tab-separated vector-valued properties (typically from pipes) into properly structured numerical segments. Each vector entry becomes a sequence of interior point values along a new index level. Scalar properties remain unchanged and are placed under interior point -1 to maintain consistent indexing.

add_interior_points_to_start_end_sequence(df_results)

Convert VEC vector columns from tab-separated strings into: - <prop>_start: first element - <prop>_end: last element - <prop>_sequence: a tuple containing all elements

Non-VEC properties remain scalar and unchanged.

Parameters:

df_results (pd.DataFrame) – pd.DataFrame with VEC properties as tab-separated strings

Returns:

DataFrame with expanded scalar VEC columns

Return type:

pd.DataFrame

convert_rows_to_single_tuple_row(df: DataFrame) → Tuple[DataFrame, dict]

Collapse a multi-row dataframe into a single-row dataframe where each column cell contains a tuple with all row values in index order.

A dictionary mapping each dataframe index value to its tuple position is stored in an additional column.

Parameters:

df (pd.DataFrame) – Input dataframe with one or multiple rows.

Returns:

Single-row dataframe with tuple values per original column and one mapping column containing {index_value: tuple_position}.

Return type:

Tuple[pd.DataFrame, dict]

Description:

This method is intended for result-style dataframes where rows usually represent timestamps. The row order of df is preserved when building tuples. Works with regular columns and MultiIndex columns (as produced by generate_element_results_dataframe). The mapping dictionary allows tracing tuple positions back to the original index values. This method expects a unique dataframe index.

delete_elements_in_dataframe(dataframe: DataFrame, tk_col: str = 'tk') → List[str]

Delete all elements in a model that are present in the given dataframe, based on their tk in the specified column.

Parameters:

• dataframe (pd.DataFrame) – DataFrame containing the elements to delete. Must include a column with the element’s tk.

• tk_col (str, optional) – Name of the column in dataframe that contains the element’s tk.

Returns:

List of all tks that were successfully deleted from the model. If no elements were deleted, an empty list is returned.

Return type:

List[str]

generate_edge_dataframe(properties: List[str] | None = [], timestamps: List[str] | List[int] | None = None, tks: List[str] | None = None) → Tuple[DataFrame, dict]

Generate one combined dataframe for all supported edge element types.

The function retrieves requested model data and result data for each supported edge type, merges both per type, and concatenates all edge-type dataframes into one unified dataframe. Result values are written in the df as tuple of floats (or tuple (time) of tuple (interior point) of floats for pipe interior points) with each entry corresponding to a simulations timestamp.

Supported edge element types are: ‘Pipe’, ‘Valve’, ‘SafetyValve’, ‘PressureRegulator’, ‘DifferentialRegulator’, ‘FlapValve’, ‘PhaseSeparation’, ‘FlowControlUnit’, ‘ControlValve’, ‘Pump’, ‘DistrictHeatingConsumer’, ‘DistrictHeatingFeeder’, ‘Compressor’, ‘HeaterCooler’, ‘HeatFeederConsumerStation’.

Not supported: ‘HeatExchanger’

Parameters:

• properties (list[str], optional) – Properties requested across all edge types. Each property is validated per element type and split into model-data vs. result properties. Unknown properties are ignored for that type. Default: []. Meaning only tk, Fkcont, geometry, fkKI, fkKK, element_type, L (L=0, if missing) will be given as default cols in df_edges.

• timestamps (Union[List[str], List[int]], optional) – Timestamps to use when retrieving result properties. Supports timestamp string (eg. timestamps=[‘2023-02-13 08:00:00.000 +01:00’, ‘2023-02-13 09:00:00.000 +01:00’]) or int index (eg. timestamps=[8, 9]. corresponding to simulation timestamps self.GetTimeStamps()[0]) Default: self.GetTimeStamps()[1].(Stationary)

• tks (List[str], optional) – TKs of elements to exclusively make up the dataframe.

Returns:

A dataframe containing all retrieved edges across supported types. Column sets are aligned across edge types before concatenation, so properties not available for some types remain empty (NaN). If no edge rows are available, an empty dataframe is returned. Dict mapping timestamps to tuple indices for result values is also returned.

Return type:

tuple[pd.DataFrame, dict[str, int]]

generate_element_dataframe(element_type: str, tks: list[str] | None = None, timestamps: List[str] | List[int] | None = None) → DataFrame | GeoDataFrame

Generates a comprehensive DataFrame containing model_data and static result values for all requested elements of the given type. Result values are written in the df as tuple of floats (or tuple (time) of tuple (interior point) of floats for pipe interior points) with each entry corresponding to a simulations timestamp. Geometry and end-node tks are always included. All model_data and result values (self.GetResultProperties_from_elementType(onlySelectedVectors=False)) for are included. The tks of end nodes are included (fkKI, fkKK). Geometry information is also included.

Parameters:

• element_type (Enum) – The element type (e.g., self.ObjectTypes.Node, self.ObjectTypes.Pipe).

• tks (list[str], optional) – List of tks to include in the dataframe. Default: None.

• timestamps (Optional[Union[List[str], List[int]]], optional) – Timestamps used for obtaining result values. Default: Static.

Returns:

DataFrame containing one row per element instance, including model_data, end nodes, geometry, and available static result values. Dict mapping timestamps to tuple indices for result values is also returned.

Return type:

tuple[pd.DataFrame, dict[str, int]]

generate_element_model_data_dataframe(element_type: Enum, tks: List[str] | None = None, properties: List[str] | None = None, geometry: bool | None = False, end_nodes: bool | None = False, element_type_col: bool | None = False, resolve_references: bool | None = False) → DataFrame | GeoDataFrame

Generate a dataframe with model data (static) properties for all devices of a given element type.

Parameters:

• element_type (Enum) – The element type (e.g., self.ObjectTypes.Node).

• tks (list[str], optional) – List of tks of instances of the element type to include. All other tks will be excluded. Use for filtering. Default: None (no filtering)

• properties (list[str], optional) – List of model data property names to include. If properties=None ⇒ all available properties are used. If properties=[] ⇒ no properties are used. Default: None.

• geometry (bool, optional) – If True, includes geometric information for each element in the dataframe. Adds a ‘geometry’ column containing spatial data (WKT representation, e.g. POINT (x y)). An attempt will be made to transform the Dataframe into a GeoDataFrame. The success depends on whether an SRID is defined in the SIR 3S model. Default: False.

• end_nodes (bool, optional) – If True and supported by the element type, includes tks of end nodes as columns (fkKI, fkKK, fkKI2, fkKK2). Default: False.

• element_type_col (bool, optional) – If True, adds a column indicating the element type. Useful when merging dataframes later. Default: False.

• resolve_references (bool, optional) – Determine whether references to tables such as Nominal Diameter Tables (Nennweitentabelle) should be resolved or left just as a reference. WORK IN PROGRESS. Works just for Nominal Diameter Tables for Pipes. Default: False

Returns:

DataFrame (or GeoDataFrame) with one row per device (tk) and columns for the requested model data properties, geometry and end nodes. Columns: [“tk”, <model_data_props>]

Return type:

pd.DataFrame | gpd.GeoDataFrame

Description:

Generates a DataFrame (or GeoDataFrame) containing static model data for all elements of a given type. The core of the sir3stoolkit usually returns values without datatypes, that are then interpreted as strings. This function infers and assigns datatypes based on values, therefore misassignments of data types can happen. Tk retains string data type. Vectorized values are split into three columsn property_start, property_end, property_sequence(closed interval including start and end).

generate_element_results_dataframe(element_type: Enum, tks: List[str] | None = None, properties: List[str] | None = None, timestamps: List[str] | List[int] | None = None, place_holder_value: float | None = 99999.0, drop_full_place_holder_columns: bool | None = True) → DataFrame

Generate a dataframe with RESULT (time-dependent) properties for all devices and timestamps.

Parameters:

• element_type (Enum) – The element type (e.g., self.ObjectTypes.Node).

• tks (list[str], optional) – List of tks of instances of the element type to include. All other tks will be excluded. Use for filtering. Default: None (no filtering)

• properties (list[str], optional) – List of RESULT property names to include. If properties=None ⇒ includes all available result properties (per element, only if values exist). If properties=[] ⇒ no properties are used. Default: None.

• timestamps (list[Union[str, int]], optional) –

  List of timestamps to include. Can be: - List of timestamp strings

  (e.g., [“2025-09-25 00:00:00.000 +02:00”, “2025-09-25 00:05:00.000 +02:00”])

  • List of integer indices

    (e.g., [0, 7, -1]) where 0 = first timestamp, 7 = eighth timestamp, -1 = last timestamp.

  Default: None (includes all available timestamps).

• place_holder_value (float, optional) – float values to be used if SIR 3S calculations do not return results. Default: 99999.0

• drop_full_place_holder_columns (bool, optional) – Determine whether columns, that are completley filled with place holder values, get dropped. Default: True

Returns:

DataFrame with one row per timestamp and MultiIndex columns: - Level 0: tk (device ID) - Level 1: name (device name) - Level 2: end_nodes (tuple of connected node tks as string) - Level 3: property (result name) Data types: float for scalars, str for vectorized data and literal strings.

Return type:

pd.DataFrame

Description:

Generates a DataFrame containing time-dependent result vectors for all selected devices and timestamps. Supports both timestamp strings and index-based selection. Produces a MultiIndex-column DataFrame grouped by device, name, end-nodes, and property.

generate_longitudinal_section_dataframes() → List[DataFrame]

Generates dataframes for longitudinal sections. Stationary timestamp is used for result values.

Parameters:

self – Instance of SIR_Model_Dataframes class

Returns:

List of dataframes of the form [section_1_VL, section_1_RL, section_2_VL, section_2_RL, …, section_lfdnr_VL, section_lfdnr_RL, …]

Return type:

List[DataFrame|GeoDataFrame]

get_EPSG() → Tuple[str]

Returns SRID, SRID and combined String. For example: (‘25832’, ‘1571’, ‘25832-1571’)

get_current_mx1_filepath(dot_resolution: int = 1) → str

Build the absolute path to the .MX1 result metadata file of the currently open model.

Derived from the model’s working directory (GetWorkingDirectory()) and its model identifier (self.Mid, as passed to OpenModel(), e.g. “M-1-0-1”): the three numbers in Mid become the B/V/BZ subdirectories, and the file itself is named “<Mid>.<dot_resolution>.MX1”, e.g.: “<working_directory>B1V0BZ1M-1-0-1.1.MX1”

TODO before shipping: dot_resolution is currently assumed to always be 1. Confirm where this value actually comes from (it may not always be 1) before relying on this in production.

Parameters:

dot_resolution (int, optional) – The dot-resolution segment of the .MX1 filename (the “.Y” from 90-10 on). Default: 1 (current assumption, unverified for all cases).

Returns:

Absolute path to the .MX1 file of the currently open model. Existence of the file is not checked here.

Return type:

str

get_dataframe_from_time_table(time_table_tk: str, value_col_name: str = None, flag_mapping: dict = None) → DataFrame

Obtain time variable table (tables = [“VarPressureTable”, “VarFlowTable”, “ValveLiftTable”, “PumpSpeedTable”, “MeasuredVariableTable”, “LoadFactorTable”, “ThermalOutputTable”, “TemperatureTable”]) in format of a pandas dataframe with time and value column.

Parameters:

• self

• time_table_tk (str) – Tk of time table to get time-value pairs from.

• value_col_name (str) – Name given to the value column.

• flag_mapping (dict) – Optional mapping of delta_time. If provided, an additional column operation_flag is added to the returned dataframe. Not necessary for usual use.

Returns:

DataFrame with time index (Zeit [s]) and columns value_col and tk.

Return type:

pd.DataFrame

get_dataframes_from_nominal_diameter_tables() → DataFrame

Retrieve and assemble row-wise property data for all nominal diameter tables, returning both a vertically concatenated DataFrame and a dictionary of individual nominal diameter DataFrames.

Parameters:

element_type (Enum) – Static table element type whose row data should be extracted (eg. table_type=self.ObjectTypes.PipeTable).

Returns:

A tuple containing:

• df_v: vertically concatenated DataFrame of all rows from all tables (needed for other functions)

• dfs: dictionary mapping each table tk to its DataFrame

• tks_of_nominal_diameter_table: list of table tks of the given type

Return type:

Tuple[pd.DataFrame, Dict[Any, pd.DataFrame], List[Any]]

get_dataframes_from_time_table_type(time_table_type: str) → List[DataFrame]

Get DataFrames for all time tables of a given type and a joint horizontally concatenated DataFrame.

Parameters:

• self

• time_table_type (str) – The time table type to extract. Must be one of: [“VarPressureTable”, “VarFlowTable”, “ValveLiftTable”, “PumpSpeedTable”, “MeasuredVariableTable”, “LoadFactorTable”, “ThermalOutputTable”, “TemperatureTable”].

Returns:

A tuple containing:

• df_h:

  The joint DataFrame. If multiple tables are found, this is a column-wise concatenation (axis=1, join='outer') of all per-TK DataFrames with the index sorted ascending. If only one table exists, it is returned directly.

• dfs:

  A dictionary mapping each TK to its corresponding DataFrame (key: TK, value: DataFrame).

• tks_of_time_table_type:

  The list of TKs for the requested time table type, in the order returned by GetTksofElementType.

Return type:

tuple[pd.DataFrame, dict[Any, pd.DataFrame], list[Any]]

initialize_mx_read_helpers(mx1_filepath: str) → dict

Initialize MX read helper state from an MX1 filepath.

This method mirrors the legacy initialization sequence: parse MX1, parse MX2, build record-unpack format, then build channel indices.

Parameters:

mx1_filepath (str) – Absolute or relative path to .MX1 file.

Returns:

Summary dictionary with resolved paths and basic counts.

Return type:

dict

insert_dataframe_into_time_table(time_table_tk: str, dataframe: DataFrame, reference_time_stamp=None, overwrite: bool = True, keep: bool = True, date_col: str = 'TAG', time_col: str = 'UHRZEIT', value_col: str = 'WERT') → DataFrame

Imports time-value pairs for a time table based on the provided dataframe into a SIR 3S model. Existing rows are matched by simulation-time value in seconds (derived from date/time and reference_time_stamp). If source time series has duplicates, the one with lowest numerical value is used. How previously existing rows in the target time table are handled is determined by the params overwrite and keep.

Parameters:

• self

• time_table_tk (int) – Tk of time table ([“VarPressureTable”, “VarFlowTable”, “ValveLiftTable”, “PumpSpeedTable”, “MeasuredVariableTable”, “LoadFactorTable”, “ThermalOutputTable”, “TemperatureTable”]) to set time-value pairs for. Does not work with weather data table.

• dataframe (pd.Dataframe) – Pandas dataframe with date_col, time_col, value_col

• reference_time_stamp (str) – “0-timestamp” - the difference to this timestamp will be calculated for each timestamp in the dataframe and used in the time table, default=self.GetTimeStamps()[0][0] - first simulation timestamp, values like “%Y-%m-%d %H:%M:%S.%f”

• overwrite (bool) – If True, existing matching time deltas are updated in-place; if False, matching entries are deleted and reinserted.

• keep (bool) – If True, old target time deltas without source counterpart are kept; if False, they are deleted.

• date_col (str) – Name of date col in dataframe, default = “TAG”, values like “2026-01-01”, “%Y-%m-%d”

• time_col (str) – Name of time col in dataframe, default = “UHRZEIT”, values like “00:00:20.000000”, “%H:%M:%S.%f”

• value_col (str) – Name of value col in dataframe, default = “WERT”, values like 83 or 1.2

Returns:

Dataframe with time-value pairs inserted into the time table with operation flag (overwritten/inserted/kept) column

Return type:

pd.DataFrame

merge_model_data_and_results(df_model_data, df_results)

read_mx_results(mx1_filepath: str | None = None, timestamps: List[str] | None = None) → DataFrame

Standalone MX result reader. Reads simulation results directly from the binary .MXS result file (via the .MX1/.MX2 metadata) instead of going through the SIR 3S Toolkit API.

WORK IN PROGRESS: Not wired into generate_element_results_dataframe() or any other dataframe generation/filtering yet. Intended for checking the raw MX read against the legacy PT3S.Mx output.

NOT HANDLED: SIR 3S can also write wall-clock-timestamped archive snapshots (“{base}_{YYYY-MM-DD_HH-MM}_UTC.{res}.MXS”, gated by TIMD.JARCH/NARCH/JZEIT) alongside the regular “{base}.{res}.MXS” files. These reuse the same {res}-tagged record layout but aren’t derivable from output_factor_small/output_factor_large alone (their name depends on when the calc was run, not on any setting value) and are out of scope here — this function only ever targets the two deterministic per-resolution files.

Parameters:

• mx1_filepath (str, optional) – Absolute or relative path to .MX1 file. Default: None. If not given, the path is resolved automatically for the currently open model via get_current_mx1_filepath(): the model’s currently configured output_factor_small/output_factor_large (SIR 3S: TIMD.DTFAK_KLEIN / TIMD.DTFAK_GROSS, see _discover_output_factors()) are looked up first. If they’re equal, only one resolution (and one file) exists and that path is used. If they differ, two structurally different files exist (different channel sets and time resolutions - see read_mx_results() call in the tutorials for a worked example) and this function cannot guess which one you want: a ValueError is raised naming both candidate paths, and mx1_filepath must be passed explicitly instead.

• timestamps (list[str], optional) – Timestamps to keep, in the same form as the resolved valid_timestamps used by generate_element_results_dataframe() (i.e. timestamp strings as returned by self.GetTimeStamps()). Matching is done on the parsed instant (via pandas), not on the literal string, so minor formatting differences don’t matter. Every record in the .MXS file still has to be scanned sequentially (its TIMESTAMP field is read directly from the raw record bytes, without a struct-format unpack of the remaining channels), but only matching records pay the full per-channel unpack/decode cost. This is the expensive part for records that are skipped. Default: None (keep all TIMESTAMPs found in the file).

Returns:

DataFrame with one row per unique TIMESTAMP (first occurrence kept for duplicate SIR 3S TIMESTAMPs, e.g. the initial STAT/TIME pair and the final TIME/TMIN/TMAX triple) and one column per MX channel (Sir3sID: OBJTYPE~NAME1~NAME2~tk~ATTRTYPE). Scalar channels hold their raw unpacked value (float/int, or bytes for CHAR channels e.g. CVERSO/SNAPSHOTTYPE). Vector channels (interior points) hold a tuple of raw unpacked values.

Return type:

pd.DataFrame

Created on Weg Sep 01 14:04:43 2025

This module implements the generation of SIR 3S models in alternative model formats such as pandapipes or nx-Graphs.

@author: Jablonski

class sir3stoolkit.mantle.alternative_models.SIR3S_Model_Alternative_Models

Bases: SIR3S_Model_Dataframes

This class is supposed to extend the Dataframes class that extends the general SIR3S_Model class with the possibility of using alternative District Heating models such as pandapipes.

SIR_3S_to_nx_graph()

Build a directed NetworkX graph from SIR 3S model.

Returns:

Directed graph with nodes and edges populated from SIR 3S model.

Return type:

nx.DiGraph

SIR_3S_to_pandapipes()

Converts the currently open SIR 3S network into a pandapipes network.

This function creates a pandapipes network that mirrors the structure of the SIR 3S network, including junctions (nodes), pipes, and external sources/sinks. Only elements of type Node and Pipe are included; FWVB (district heating consumers) are excluded.

Returns:

A pandapipes network object containing: - Junctions with model data and result values (pressure, temperature, flow). - Pipes with geometry and physical parameters. - External grids (sources) and sinks based on node type and flow direction.

Return type:

pandapipes.pandapipesNet

add_properties_to_graph(G: DiGraph, element_type: str, properties: List[str], timestamp: str | None = None) → DiGraph

Enrich nodes and edges in G with additional attributes by joining on ‘tk’.

Parameters:

• G (nx.DiGraph) – The already-built graph where nodes/edges have at least a ‘tk’ attribute.

• element_type (str) – The element type to filter by (must match df[element_type_col] and edge attr “element type”).

• properties (list of str) – Column names from the dataframe to add as attributes

• timestamp (str) – Timestamp used for adding result properties. If None, STAT will be used.

Returns:

The same graph instance with enriched attributes.

Return type:

nx.DiGraph

get_object_type_enum(element_type: str)

Return the enum member from self.ObjectTypes corresponding to the given element_type string.

Parameters:

element_type (str) – Name of the element type (e.g., ‘Node’, ‘Pipe’).

Return type:

Enum member from self.ObjectTypes if found, else None.

Created on Thu Okt 7 13:39:13 2025

This module implements general plotting functions for SIR 3S applications. TODO: AGSN, Time Curves, Network Color Diagram

@author: Jablonski

class sir3stoolkit.mantle.plotting.SIR3S_Model_Plotting

Bases: SIR3S_Model

plot_node_layer(ax=None, gdf=None, *, size_scaling_col: str | None = None, color_mixing_col: str | None = None, attribute: str | None = None, colors=('darkgreen', 'magenta'), legend_fmt: str | None = None, legend_values: list[float] | None = None, size_vmin: float | None = None, size_vmax: float | None = None, color_vmin: float | None = None, color_vmax: float | None = None, query: str | None = None, marker_style: str = 'o', marker_size_factor: float = 1000.0, zorder: float | None = None, show_value_labels: bool = False, value_label_fmt: str = '{:.4f}', value_label_fontsize: float = 8.0, value_label_offset: tuple[float, float] = (2.0, 2.0))

Plot point nodes with separate size and color scaling.

Parameters:

• ax (matplotlib.axes.Axes, optional) – Axis to plot into. If None, uses current axes (plt.gca()).

• gdf (pandas.DataFrame or geopandas.GeoDataFrame) – Input with a ‘geometry’ column of shapely geometries (z-coord is stripped if present).

• size_scaling_col (str, optional) – Column used to scale marker sizes (numeric). If None, uses attribute if provided; otherwise constant size.

• color_mixing_col (str, optional) – Column used to color markers (numeric). If None, uses attribute if provided; otherwise a constant color.

• attribute (str, optional) – Legacy single column used for both size and color if the specific columns are not provided.

• colors (tuple[str, str], optional) – Two colors to build a linear segmented colormap.

• legend_fmt (str, optional) – Legend label format, default: f”{color_col} {{:.4f}}”.

• legend_values (list[float], optional) – Explicit legend tick values; default: 5 linear steps.

• size_vmin (float, optional) – Bounds for size normalization; defaults to data min/max.

• size_vmax (float, optional) – Bounds for size normalization; defaults to data min/max.

• color_vmin (float, optional) – Bounds for color normalization; defaults to data min/max.

• color_vmax (float, optional) – Bounds for color normalization; defaults to data min/max.

• query (str, optional) – Pandas query string to filter rows before plotting.

• marker_style (str, optional) – Matplotlib marker style, default ‘o’.

• marker_size_factor (float, optional) – Factor applied after size normalization, default 1000.0.

• zorder (float, optional) – Z-order for drawing.

• show_value_labels (bool, optional) – If True and a color scaling column is active, draw the numeric color value next to each point using its mapped color.

• value_label_fmt (str, optional) – Format string used for value labels, default “{:.4f}”.

• value_label_fontsize (float, optional) – Font size for value labels, default 8.0.

• value_label_offset (tuple[float, float], optional) – Offset in points for value labels relative to each point.

Returns:

Legend patches based on the color scaling column; None if constant color.

Return type:

list[matplotlib.patches.Patch] or None

plot_pipe_layer(ax=None, gdf=None, *, width_scaling_col: str | None = None, color_mixing_col: str | None = None, attribute: str | None = None, colors=('darkgreen', 'magenta'), legend_fmt: str | None = None, legend_values: list[float] | None = None, width_vmin: float | None = None, width_vmax: float | None = None, color_vmin: float | None = None, color_vmax: float | None = None, query: str | None = None, line_width_factor: float = 10.0, zorder: float | None = None, show_value_labels: bool = False, value_label_fmt: str = '{:.4f}', value_label_fontsize: float = 8.0, value_label_offset: tuple[float, float] = (2.0, 2.0))

Plot line geometries with separate width and color scaling.

Parameters:

• ax (matplotlib.axes.Axes, optional) – Axis to plot into. If None, uses current axes (plt.gca()).

• gdf (pandas.DataFrame or geopandas.GeoDataFrame) – Input with a ‘geometry’ column of shapely LineString/MultiLineString (z-coord is stripped if present).

• width_scaling_col (str, optional) – Column used to scale line widths (numeric). If None, uses attribute if provided; otherwise constant width.

• color_mixing_col (str, optional) – Column used to color lines (numeric). If None, uses attribute if provided; otherwise a constant color.

• attribute (str, optional) – Legacy single column used for both width and color if the specific columns are not provided.

• colors (tuple[str, str], optional) – Two colors to build a linear segmented colormap.

• legend_fmt (str, optional) – Legend label format, default: f”{color_col} {{:.4f}}”.

• legend_values (list[float], optional) – Explicit legend tick values; default: 5 linear steps.

• width_vmin (float, optional) – Bounds for width normalization; defaults to data min/max.

• width_vmin – Bounds for width normalization; defaults to data min/max.

• color_vmin (float, optional) – Bounds for color normalization; defaults to data min/max.

• color_vmax (float, optional) – Bounds for color normalization; defaults to data min/max.

• query (str, optional) – Pandas query string to filter rows before plotting.

• line_width_factor (float, optional) – Factor applied after width normalization, default 10.0.

• zorder (float, optional) – Z-order for drawing.

• show_value_labels (bool, optional) – If True and a color scaling column is active, draw the numeric color value next to each element using its mapped color.

• value_label_fmt (str, optional) – Format string used for value labels, default “{:.4f}”.

• value_label_fontsize (float, optional) – Font size for value labels, default 8.0.

• value_label_offset (tuple[float, float], optional) – Offset in points for value labels relative to their anchor position.

Returns:

Legend patches based on the color scaling column; None if constant color.

Return type:

list[matplotlib.patches.Patch] or None

plot_time_curves(df: DataFrame, start=None, end=None, properties=None, axis_labels=None, ylims=None, tks_per_property=None, y_label_ticks=None, y_grid_ticks=None, x_label_ticks=None, x_grid_ticks=None, figsize=(20, 14), axis_offset=60, linestyles=None, legend=True, legend_fontsize=8, legend_loc='upper left', legend_coords=(0.67, 0.33), legend_in_figure=True, missing='skip', normalize=<method 'upper' of 'str' objects>, aliases=None, title_prefix='', show_title=True, rotate_xticks=0, grid=True, grid_style='--', grid_alpha=0.3, logger=None)

Plot multiple properties using multiple y-axes (all on the left). Optionally restrict which TKs are plotted for each property.

Legend labels are “PROPERTY NAME”.

Tick/grid separation: - Labeled ticks come from major ticks (x_label_ticks, y_label_ticks) - Grid lines come from minor ticks (x_grid_ticks, y_grid_ticks) - Horizontal grid is based on the first y-axis (axis 0)

Parameters:

• df (pandas.DataFrame) – Input DataFrame with MultiIndex columns (from s3s.generate_element_results_dataframe()). Level 0 must represent TK/group; last level must represent property. A column level named “name” is used for legend labels if present.

• start (Any) – Start timestamp (inclusive) for slicing and x-axis limits. If None, uses first timestamp in df.

• end (Any) – End timestamp (inclusive) for slicing and x-axis limits. If None, uses last timestamp in df.

• properties (list[str] | None) – List of property names to plot (matched against the last MultiIndex level). If None, plots all properties found.

• axis_labels (list[str] | None) – List of y-axis labels corresponding to properties. If None, uses “property=<name>”.

• ylims (list[tuple[float, float] | None] | None) – List of y-limits tuples per property axis, e.g. [(0, 12), (0, 40), (0, 60)]. Use None entries to keep autoscale.

• tks_per_property (list[list[str] | set[str] | None] | None) – List of lists/sets of TKs allowed per property. If an entry is None or empty, all TKs are allowed.

• y_label_ticks (list[int] | None) – Number of labeled y-ticks per axis (one int per property/axis). If None, leaves default tick behavior.

• y_grid_ticks (int | None) – Number of horizontal grid lines (minor y-ticks) based on the first y-axis. If None, no minor y-grid control.

• x_label_ticks (int | None) – Number of labeled x-ticks (major ticks). If None, uses AutoDateLocator for major ticks.

• x_grid_ticks (int | None) – Number of vertical grid lines (minor x-ticks). If None, no minor x-grid control.

• figsize (tuple[int, int]) – Matplotlib figure size.

• axis_offset (int) – Outward offset (in points) between stacked left-side y-axes.

• linestyles (list[str] | None) – List of linestyles used per property (cycled if shorter than properties). Default cycles [“-“,”–“,”:”,”-.”].

• legend (bool) – Whether to draw a legend.

• legend_fontsize (int | float) – Legend font size.

• legend_loc (str) – Legend location argument passed to matplotlib (e.g. “upper left”).

• legend_coords (tuple[float, float]) – Legend anchor coordinates passed as bbox_to_anchor.

• legend_in_figure (bool) – If True, uses fig.legend(…) (more robust for multiple twinx axes). If False, uses ax0.legend(…).

• missing (str) – Policy if a requested property yields no plotted lines after filtering: “skip”, “warn”, or “error”.

• normalize (callable) – Function applied to property strings for robust matching (e.g. str.upper).

• aliases (dict[str, str] | None) – Mapping applied after normalization to unify names (e.g. {“PHI”: “PH”}). Keys/values must be normalized form.

• title_prefix (str) – Optional text prepended to the timeframe title.

• show_title (bool) – If True, sets a title containing the selected timeframe.

• rotate_xticks (int | float) – Rotation angle (degrees) for x tick labels.

• grid (bool) – Whether to draw grid lines (on base axis).

• grid_style (str) – Line style for grid.

• grid_alpha (float) – Alpha for grid lines.

• logger (Any) – Optional logger with .info/.warning methods. If provided, logs are prefixed with “[time curves]”.

Returns:

(fig, axes, used_properties) where axes is a list of axes (one per property), and used_properties are normalized properties used.

Return type:

tuple[matplotlib.figure.Figure, list[matplotlib.axes.Axes], list[str]]

Created on Fri Jan 23 12:11:41 2026

This module implements functions that extend the basic C# operations with more advanced operations to change a SIR 3S model.

@author: Jablonski

class sir3stoolkit.mantle.advanced_operations.SIR3S_Model_Advanced_Operations

Bases: SIR3S_Model

This class implements functions that extend the basic C# operations with more advanced operations to change a SIR 3S model.

add_element_types_to_tk_list(tks: List[str]) → List[Tuple[str, str]]

Turns list of tks into list of tuples with element type and tk. Only works for DistrictHeating networks. For other mappings we need an additional mapping. see sir3stoolkit/docs/code snippets/mapping_for_groups.ipynb

Parameters:

• self

• tks (List[str]) – List of tks of elements like [‘5428054456958551597’, ‘50736424189751239’]

Returns:

[(‘KNOT’, ‘5428054456958551597’), (‘ROHR’, ‘50736424189751239’)]

Return type:

List[Tuple[str, str]]

add_elements_to_group(group_tk: int, element_tks: List[Tuple[str, str]]) → None | int

Adds elements to a group with a list of elements.

Parameters:

• self

• group_tk (int) – Tk of the group the elements should be added to.

• element_tks (list[tuple[str, str]]) –

  Tks of elements that should be added to the group. Eg. [(‘KNOT’, ‘5428054456958551597’),

  (‘KNOT’, ‘5099111544186125239’)]

get_element_type_from_tk(tk: str) → str

Return element type for given tk.

Parameters:

• self

• tk (int) – Tk of element

Returns:

element type

Return type:

str

get_tks_of_group_elements(group_tk: int) → List[Tuple[str, str]]

Returns list of tuples with element type and tk of elements that are part of specific group.

Parameters:

• self

• group_tk (int) – Tk of group for element tk retrival

Returns:

List of tuples with element type and tk of elements of group.

Return type:

Any

remove_elements_from_group(group_tk: int, element_tks: List[Tuple[str, str]]) → None | int

Removes elements from a group with a list of elements.

Parameters:

• self

• group_tk (int) – Tk of the group the elements should be removed from.

• element_tks (list[tuple[str, str]]) –

  Tks of elements that should be removed from the group. Eg. [(‘KNOT’, ‘5428054456958551597’),

  (‘KNOT’, ‘5099111544186125239’)]

set_group_elements(group_tk: int, element_tks: List[Tuple[str, str]]) → None | int

Overwrites elements in a group with a new list of elements.

Parameters:

• self

• group_tk (int) – Tk of the group the elements should be set for.

• element_tks (list[tuple[str, str]]) –

  Tks of elements that should be set for the group. Eg. [(‘KNOT’, ‘5428054456958551597’),

  (‘KNOT’, ‘5099111544186125239’)]

Utilities

sir3stoolkit.logging_utils.emit_message(logger: Logger, message) → None

Emit a legacy message with level inference.

sir3stoolkit.logging_utils.get_logger(name: str) → Logger

Create/get module logger with a host-aware fallback print handler.

sir3stoolkit.logging_utils.get_process_executable_name() → str

Get executable name of current process when available.

sir3stoolkit.logging_utils.get_process_executable_path() → str | None

Get absolute path to current process executable when available.

sir3stoolkit.logging_utils.is_host_process() → bool

Return True when running inside SirGraf host process.

Object Types, Properties, and Result Value Types

Note

The below sections lists all table names from self.ObjectTypes_TableNames, along with their properties, result properties, and respective object type from self.ObjectTypes (needed for toolkit operations like self.InsertElement(), self.GetPropertiesOfElementType()).

AGSN

Object Type: AGSN_HydraulicProfile

Properties

Name	Value Types
Aktiv	int32
AllNodesAndLinks	dictionary`2
InVariant	boolean
Lfdnr	int32
MainWay	iagsnway
Name	string
ObjsString	string
Pk	string
Tk	string

Result Properties

No result properties found.

ALLG

Object Type: GeneralSection

Properties

Name	Value Types
Forc	int32
Idph	int32
Idqm	int32
InVariant	boolean
Name	string
Netztyp	int32
Pfadol1	string
Pk	string
bz.ArtTh	int32
bz.CalcNetwork	int32
bz.Cdat	string
bz.CheckMod	int32
bz.CheckRes	int32
bz.Cuhr	string
bz.Czon	string
bz.Fk	string
bz.Iart	int32
bz.Idra	int32
bz.Itrenn	int32
bz.Jwarn	int32
bz.Knuvtyp	int32
bz.Lfqsv	single
bz.Schwellqsig	single
bz.ThInst	int32
bz.ThStat	int32
bz.Thfakt	int32
bz.ValidAggr	int32

Result Properties

Name
CPUTIME
CVERSO
EXSTAT
FWVB_DPHMIN
FWVB_TVLMIN
INTERAKTRG
INTERAKTTH
ITERHY
ITERTH
JWARN
KNOT_PHMAX
KNOT_PHMAX_R
KNOT_PHMAX_U
KNOT_PHMAX_V
KNOT_PHMIN
KNOT_PHMIN_R
KNOT_PHMIN_U
KNOT_PHMIN_V
LFQSV
LINEPACKGEOM
LINEPACKGES
LINEPACKRATE
MAINELEMENT
MFVHYUV
MFVTHUV
MKNUV
NETZABN
NETZABNEXITS
NETZBEZ
NFEHL
NFVHYUV
NFVTHUV
NKNUV
NMELD
NPGREST
NWARN
PAV
RHOAV
SNAPSHOTTYPE
TAV
TIMESTAMP
TVMINMAX
USRTIME

ANTP

Object Type: DrivePowerTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

ANTP_ROWS

Object Type: DrivePowerTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pamax	single
Pk	string
Tumg	single

Result Properties

No result properties found.

ARRW

Object Type: Arrow

Properties

Name	Value Types
Angle	double
Beschreibung	string
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

ATMO

Object Type: Atmosphere

Properties

Name	Value Types
InVariant	boolean
Indbarf	int32
Name	string
Patmos	single
Pk	string
Rgas	single
Rpoly	single
Tatmos	single

Result Properties

No result properties found.

AVOS

Object Type: CrossSectionTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

AVOS_ROWS

Object Type: CrossSectionTable_Row

Properties

Name	Value Types
Fk	string
Flaeche	single
InVariant	boolean
Name	string
Ordinate	single
Pk	string

Result Properties

No result properties found.

BEVE

Object Type: VentValve

Properties

Name	Value Types
Alpha	single
Angle	double
Beschreibung	string
Dgr	single
Dkl	single
Fkcont	string
Fkfstf	string
GeometriesDiffer	boolean
Ibedef	int32
Ibetyp	int32
Idreferenz	string
Iekl	int32
InVariant	boolean
Iplanung	int32
Knotk	string
Name	string
Pk	string
Poeff	single
Qlbmax	single
Qlekl	single
Rgbeve	single
SymbolFactor	double
SymbolGraf	symbol1c_graf
Tk	string
Trohr	single
Vgrest	single
Xkor	double
Ykor	double
Zkor	single
bz.Fk	string

Result Properties

Name
IAKTIV
IND
M
MAINELEMENT
MLUFT
PHI
PLUFT
QLUFT
QM
QMLUFT
RHO
TLUFT
VLUFT
VOLLUFT

BEWI

Object Type: VentilatedPressureAirVessel

Properties

Name	Value Types
A	single
Angle	double
Beschreibung	string
Dn	single
Fkatab	string
Fkcont	string
Fkfstf	string
GeometriesDiffer	boolean
Hb	single
Idreferenz	string
InVariant	boolean
Indatab	int32
Iplanung	int32
Knotk	string
Lta	single
Name	string
Pg0	single
Pk	string
Rgas	single
Rpoly	single
SymbolFactor	double
SymbolGraf	symbol1c_graf
Tgas	single
Tk	string
Xkor	double
Ykor	double
Zetaneg	single
Zetapos	single
Zkor	single
bz.Fk	string

Result Properties

Name
HLUFT
IAKTIV
IND
M
MAINELEMENT
PLUFT
QM
RHO
T
TLUFT
V
VOL
VOLLUFT
VOLLUFT1
WALTER
WST

BREF

Object Type: SwitchInBlock

Properties

Name	Value Types
Beschreibung	string
BoundingRectangle	irectangle
ElementFont	c3sfont
Fkblock	string
Fkcont	string
InVariant	boolean
Name	string
Pk	string
TextColor	color
Tk	string
Xkor	double
Ykor	double

Result Properties

No result properties found.

CIRC

Object Type: Circle

Properties

Name	Value Types
Beschreibung	string
FillColor	color
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
LineColor	color
LineWidthMM	double
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

CONT

Object Type: ObjectContainerSymbol

Properties

Name	Value Types
BoundingRectangle	irectangle
GeometriesDiffer	boolean
Id	int32
Idparent	int32
Idreferenz	string
InVariant	boolean
Lfdnr	int32
MaximalNodeWidth	double
MaximalPipeWidth	double
MaximalVbelNselWidth	double
MeterPerPixel	double
Name	string
PickingTolerance	double
Pk	string
SymbolFont	c3sfont
SymbolType	ccontsymboltype
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

CRGL

Object Type: ControlEngineeringNexus

Properties

Name	Value Types
Fkcont	string
Idxke	int32
InVariant	boolean
LineWidthMM	double
Name	string
Pk	string
Tk	string

Result Properties

No result properties found.

DPGR

Object Type: DPGR_DataPointGroup

Properties

Name	Value Types
Description	string
Dtfak	int32
Idreferenz	string
InVariant	boolean
Name	string
OpcgroupName	string
OpcserverPath	string
PermissionFlags	int32
Pk	string
Tk	string
Typ	int32
bz.ExternalUse	int32
bz.Fk	string
bz.LocalUse	int32

Result Properties

No result properties found.

DPGR_DPKT

Object Type: DPGR_DPKT_DatapointDpgrConnection

Properties

Name	Value Types
Fkdpgr	string
Fkdpkt	string
InVariant	boolean
Name	string
Pk	string
Tk	string

Result Properties

No result properties found.

DPKT

Object Type: DPKT_Datapoint

Properties

Name	Value Types
Addend	single
Attrtype	string
ClientFlags	int32
ClientId	string
Datalength	int32
Datatype	string
Description	string
Deviation	single
Epkz	int32
Factor	single
Fkobjtype	string
Flags	int32
InVariant	boolean
LowerLimit	single
Name	string
Name1	string
Name2	string
Name3	string
Objtype	string
Ol3command	string
OpcitemId	string
Pk	string
Title	string
Tk	string
Unit	string
UpperLimit	single
bz.Addend	single
bz.CheckAbs	int32
bz.CheckAll	int32
bz.CheckMsg	int32
bz.ClientFlags	int32
bz.ClientId	string
bz.Deviation	single
bz.Factor	single
bz.Fk	string
bz.Fkobjtype	string
bz.LimitToler	single
bz.LowerLimit	single
bz.Name1	string
bz.Name2	string
bz.Name3	string
bz.OpcitemId	string
bz.UpperLimit	single

Result Properties

No result properties found.

DPRG

Object Type: DifferentialRegulator

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkkref1	string
Fkkref2	string
Fkzep1	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Ts	single
Typ	int32
Xkor	double
Ykor	double
bz.Dphsoll	single
bz.Fk	string
bz.Fkswvt	string
bz.Indsoll	int32

Result Properties

Name
DH
DP
DPH
DPHSOLL
DPSOLL
DSI
DSK
FS
HR
IAKTIV
KV
M
MAINELEMENT
PHI
PR
QM
RHO
SWVT
V
ZETA

DTRO

Object Type: PipeTable

Properties

Name	Value Types
Beschreibung	string
E	single
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Typ	string
Zeitoption	int32

Result Properties

No result properties found.

DTRO_ROWD

Object Type: PipeTable_Row

Properties

Name	Value Types
Ausfallzeit	single
Da	single
Di	single
Dn	string
Fk	string
InVariant	boolean
Kt	single
Name	string
Pk	string
Pn	single
Rehabilitation	single
Reparatur	single
S	single
Tk	string
Wsteig	single
Wtiefe	single

Result Properties

No result properties found.

EBES

Object Type: EBES_FeederGroups

Properties

Name	Value Types
Idreferenz	string
InVariant	boolean
Lfdnr	int32
Name	string
ObjsString	string
Pk	string
Tk	string
bz.Aktiv	int32
bz.Aktivqs	int32
bz.Fk	string
bz.Versagensw	single

Result Properties

No result properties found.

ELEMENTQUERY

Object Type: ElementQuery

Properties

Name	Value Types
Aktiv	int32
Elementtype	string
InVariant	boolean
Lfdnr	int32
Name	string
Pk	string
QueryStringAsString	string

Result Properties

No result properties found.

ERROR_NO_MAPPING__RART_ControlMode

Object Type: RART_ControlMode

Properties

No properties found.

Result Properties

No result properties found.

ERROR_NO_MAPPING__SIRGRAF

Object Type: SIRGRAF

Properties

Name	Value Types
BlockBkgndColor	int32
CacheDirectory	string
CacheInUserProfile	int32
DrawTileOutlines	int32
HighlightElement	int32
ImageQuality	int32
InVariant	boolean
LegFix	int32
LegHeight	single
LegMaxEntries	int32
LegXkor	double
LegYkor	double
ListConfigString	string
MaxLineSize	int32
MaxNodeSize	int32
MaxVbelSize	int32
Name	string
Nbnr	int32
Nknr	int32
OsmPasswd	string
OsmTimeout	int32
OsmUser	string
PickingRadius	int32
Pickingmode	int32
Pk	string
ProxyAuthMethod	int32
ProxyPasswd	string
ProxyServer	string
ProxyUser	string
Sccnln	int32
Scelt	int32
Scknot	int32
Scrohr	int32
Sfvbels	double
Srid	int32
Srid2	int32
SridString	string
StructuredViewsString	string
Sylw	single
TileDownloadServer	string
Tooltip	int32
Uimode	int32
Upkc	int32
UseHttpProxy	int32

Result Properties

No result properties found.

ETAM

Object Type: DriveEfficiencyTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

ETAM_ROWS

Object Type: DriveEfficiencyTable_Row

Properties

Name	Value Types
Etam	single
Fk	string
InVariant	boolean
Name	string
Nzun0	single
Pk	string

Result Properties

No result properties found.

ETAR

Object Type: EnergyRecoveryTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

ETAR_ROWS

Object Type: EnergyRecoveryTable_Row

Properties

Name	Value Types
Etadt	single
Fk	string
InVariant	boolean
Name	string
Nzun0	single
Pk	string

Result Properties

No result properties found.

ETAU

Object Type: EfficiencyConverterTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

ETAU_ROWS

Object Type: EfficiencyConverterTable_Row

Properties

Name	Value Types
Etafu	single
Fk	string
InVariant	boolean
Name	string
Nzun0	single
Pk	string

Result Properties

No result properties found.

FKNL

Object Type: FreeDuct

Properties

Name	Value Types
Beschreibung	string
BoundingRectangle	irectangle
Cdim	string
ElementFont	c3sfont
Fkcont	string
InVariant	boolean
Name	string
Oalm	single
Owarn	single
Pk	string
Showname	int32
Showrect	int32
T	single
Tk	string
Ualm	single
Uwarn	single
Xkor	double
Ykor	double
bz.Afakt	single
bz.Dt	single
bz.Dy	single
bz.Fk	string
bz.Fkwtab	string
bz.Ityp	int32
bz.Wert	single

Result Properties

Name
MAINELEMENT
OA
OW
UA
UW
WERT

FQPS

Object Type: FluidQualityParamSet

Properties

Name	Value Types
Chlorid	single
Eisenfilt	single
Eisenges	single
Hi	single
Hs	single
InVariant	boolean
Indchlorid	int32
Indeisenfilt	int32
Indeisenges	int32
Indhi	int32
Indhs	int32
Indleitfaeh	int32
Indmn	int32
Indphwert	int32
Indrhon	int32
Indsulfat	int32
Indtemp	int32
Leitfaeh	single
Lfdnr	int32
Mn	int32
Name	string
Phwert	single
Pk	string
Rhon	single
Sulfat	single
Temp	single
Tk	string
Walter	single
bz.Fk	string
bz.Fkswvtchlorid	string
bz.Fkswvteisenfilt	string
bz.Fkswvteisenges	string
bz.Fkswvthi	string
bz.Fkswvths	string
bz.Fkswvtleitfaeh	string
bz.Fkswvtmn	string
bz.Fkswvtphwert	string
bz.Fkswvtrhon	string
bz.Fkswvtsulfat	string
bz.Fkswvttemp	string

Result Properties

Name
MAINELEMENT
SWVTCHLORID
SWVTEISENFILT
SWVTEISENGES
SWVTHI
SWVTHS
SWVTLEITFAEH
SWVTMN
SWVTPHWERT
SWVTRHON
SWVTSULFAT
SWVTTEMP

FQPS_BZ

Object Type: FluidQualityParamSet_OS

Properties

Name	Value Types
Fk	string
Fkswvtchlorid	string
Fkswvteisenfilt	string
Fkswvteisenges	string
Fkswvthi	string
Fkswvths	string
Fkswvtleitfaeh	string
Fkswvtmn	string
Fkswvtphwert	string
Fkswvtrhon	string
Fkswvtsulfat	string
Fkswvttemp	string
InVariant	boolean
Name	string
Pk	string

Result Properties

No result properties found.

FSTF

Object Type: FluidThermalPropertyGroup

Properties

Name	Value Types
Cp	single
Dracoeffa	single
Dracoeffb	single
Dracoeffc	single
Dynvisko	single
Eps	single
Fkgmix	string
Fkstof	string
Gkomp1	single
Gkomp2	single
Idreferenz	string
InVariant	boolean
Indstf	int32
Isotherm	single
K	single
Name	string
Pk	string
Pref	single
Rhonorm	single
Tabdnam	string
Tk	string
Tref	single

Result Properties

No result properties found.

FWBZ

Object Type: FWBZ_DistrictHeatingReferenceValues

Properties

Name	Value Types
Ahausg	single
Arohr	single
Flfwvb	single
Hgebzg	single
Ikotyp	int32
InVariant	boolean
Lambdabzg	single
Name	string
Pk	string
Rhobzg	single
Vhausg	single
Zerohr	single

Result Properties

No result properties found.

FWEA

Object Type: HeatFeederConsumerStation

Properties

Name	Value Types
Abrutto	single
Angle	double
Beschreibung	string
Deta0bLost	single
Dhbasis	single
Di	single
Dn	single
Dpes0	single
Dpvb0min	single
Dtsett	single
Dtwt	single
Fkcont	string
Fkfwes	string
Fkfwvb	string
Fkklap	string
Fkpreg	string
Fkpump	string
Fksoko	string
Fktrft	string
Fkzep1Pr	string
GeometriesDiffer	boolean
Gtmaxtset	single
HBUkDif	single
HDif	single
HMantel	single
HWsMax	single
HWsOkDif	single
He	single
Idreferenz	string
InVariant	boolean
Indrohr	int32
Indrumg	int32
Indtr	int32
Indtrack	int32
Indtset	int32
Indusing	int32
Indwt	int32
Iplanung	int32
Kr	single
KrKt	single
L	single
Lambdad	single
Lambdae	single
Medium	int32
Name	string
NodeNameI	string
NodeNameK	string
Pk	string
PositionOfDescription	int32
PrDn	single
PuHref	single
PuNref	single
PuPref	single
PuQmref	single
Qfs	single
RDif	single
RInnen	single
Rd	single
ShowDescription	boolean
StorageType	int32
SymbolFactor	double
Tdr	single
Tgrenz	single
Tk	string
Tob	single
TrefMin	single
Trl0	single
Trs0	single
Tru	single
Tsp0	single
TtolEs	single
TtolVb	single
Tu	single
Tvl0	single
UBoden	single
UMantel	single
Volsp	single
Vrv	single
W0Es	single
W0Sp	single
W0Vb	single
Wcorr	single
Xkor	double
Ykor	double
bz.Azimut	single
bz.Einaus	int32
bz.Fk	string
bz.Fklfkt	string
bz.FkqvarSp	string
bz.FktevtEs	string
bz.FktevtRs	string
bz.FkwevtEs	string
bz.FkwevtSp	string
bz.FkwevtVb	string
bz.Fkwttr	string
bz.HWsStart	single
bz.Indlast	int32
bz.IndsSp	int32
bz.Indstagn	int32
bz.Ithtyp	int32
bz.ModeSp	int32
bz.Neigung	single
bz.Ppumax	single
bz.Pvlmax	single
bz.Qsprel0	single
bz.TobStart	single
bz.TrsMax	single
bz.TspMin	single
bz.TtolEval	single
bz.TuStart	single
bz.TzuMax	single
bz.TzuMin	single
bz.W0SpMin	single

Result Properties

Name
DH_KALT
DH_MIX
DH_WARM
DPH_ES
DPH_VB
DTLEER
ETA_PU
GGLOB
GKOLL
H_MIX
H_PU
H_WS
IAKTIV
MAINELEMENT
MMAXBL
MMAXEL
MMIN
N_PU
P_PU
QM
QM_ES
QM_PR
QM_VB
QSP
QSPREL
QV_BODEN
QV_DR
QV_MANTEL
QV_TOTAL
Q_PU
TDIFFO
TDIFFU
TRL
TRS
TSP
TVEC
TVL
T_KALT
T_MIX
T_WARM
W
WKOLL
W_ES
W_FS
W_PR
W_RO
W_VB

FWES

Object Type: DistrictHeatingFeeder

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Irueck	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Taus	single
Tk	string
Xkor	double
Ykor	double
Zeta	single
bz.Fk	string
bz.Fktevt	string
bz.Fkwevt	string
bz.Ihytyp	int32
bz.IhytypKlartext	string
bz.Ithtyp	int32
bz.IthtypKlartext	string
bz.Tkon	single
bz.Wkon	single

Result Properties

Name
DH
DP
DPH
IAKTIV
IHYTYP
ITHTYP
M
MAINELEMENT
QM
RHOI
RHOK
TEVT
TI
TK
TKON
V
W
W0
WEVT
WSOLL

FWVB

Object Type: DistrictHeatingConsumer

Properties

Name	Value Types
A	single
Angle	double
B	single
Beschreibung	string
C	single
CPM	double
Dphaus	single
Dprlmin	single
Dpvlmin	single
Dtmin	single
Fkcont	string
Fktrft	string
Fkzep1rl	string
Fkzep1vl	string
GeometriesDiffer	boolean
Idreferenz	string
Imbg	int32
InVariant	boolean
Ind0	int32
Indtr	int32
IndtrKlartext	string
Iplanung	int32
Irfv	int32
Lfk	single
M0Estimated	single
Name	string
NumberOfVERB	int32
P1soll	single
Pk	string
PositionOfDescription	int32
Qm0	single
Rho0	single
ShowDescription	boolean
SymbolFactor	double
Tk	string
Trs0	single
Trsk	single
Tsrl	single
Tsvl	single
Tvl0	single
V0	single
Vtyp	int32
W0	single
W0Estimated	single
Xkor	double
Ykor	double
Zevk	single
bz.Fk	string
bz.Fklfkt	string
bz.Fklfkt2	string
bz.Fkqvar	string
bz.Fktevt	string
bz.Indlast	int32
bz.IndlastKlartext	string
bz.Indlfkt2	int32

Result Properties

Name
DH
DP
DPH
IAKTIV
INDUV
LFH
LFKT
LFT
M
MAINELEMENT
MHYUV
MSOLL
MTHUV
P1
P2
P3
PH1
PH2
PH3
PHIRL
PHIVL
QM
QM13
QM31
QMI
QMK
QVAR
RHOI
RHOK
TI
TK
TVMIN
W
WHYUV
WSOLL
WTHUV

FWWU

Object Type: HeatExchanger

Properties

Name	Value Types
A	single
Alpha1	single
Alpha2	single
Angle	double
Beschreibung	string
Dn	single
Dp10min	single
Dp20	single
Expert	int32
Fkcont	string
Fkfwes	string
Fkfwvb	string
Fkzep1rl	single
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Inddprl	int32
Indwue	int32
Iplanung	int32
K	single
Kstrant	single
L1	single
L2	single
Name	string
Pk	string
PositionOfDescription	int32
Re0	single
ShowDescription	boolean
SymbolFactor	double
T1aus0	single
T1ein0	single
T2aus0	single
T2ein0	single
Tk	string
Tsrl	single
W0	single
Xkor	double
Ykor	double
bz.Einaus	int32
bz.Fk	string
bz.Fktevt	string
bz.Ithtyp	int32
bz.T2aus	single

Result Properties

Name
AKTIV
C1
C2
EPS1
EPS2
IAKTIV
INDUV
KA
MAINELEMENT
NTU1
NTU2
NU1
NU2
PR1
PR2
Q
RE1
RE2
T1AUS
T1EIN
T2AUS
T2EIN
THETA
TMLOG
W1
W2

GKMP

Object Type: GasComponent

Properties

Name	Value Types
BwrA	single
BwrA0	single
BwrAlpha	single
BwrB	single
BwrB0	single
BwrC	single
BwrC0	single
BwrGamma	single
CpicoefA	single
CpicoefB	single
CpicoefC	single
CpicoefD	single
CpicoefE	single
Formula	string
Hi	single
Hs	single
InVariant	boolean
Lfdnr	int32
Molarmass	single
Name	string
Pc	single
Pk	string
Tb	single
Tc	single
Tk	string
Zisocoef	single

Result Properties

No result properties found.

GMIX

Object Type: GasMixture

Properties

Name	Value Types
Beschreibung	string
Fkgkmp1	string
Fkgkmp10	string
Fkgkmp11	string
Fkgkmp12	string
Fkgkmp13	string
Fkgkmp14	string
Fkgkmp15	string
Fkgkmp16	string
Fkgkmp17	string
Fkgkmp18	string
Fkgkmp19	string
Fkgkmp2	string
Fkgkmp20	string
Fkgkmp21	string
Fkgkmp22	string
Fkgkmp3	string
Fkgkmp4	string
Fkgkmp5	string
Fkgkmp6	string
Fkgkmp7	string
Fkgkmp8	string
Fkgkmp9	string
Idreferenz	string
InVariant	boolean
Lfdnr	int32
Molfrac1	single
Molfrac10	single
Molfrac11	single
Molfrac12	single
Molfrac13	single
Molfrac14	single
Molfrac15	single
Molfrac16	single
Molfrac17	single
Molfrac18	single
Molfrac19	single
Molfrac2	single
Molfrac20	single
Molfrac21	single
Molfrac22	single
Molfrac3	single
Molfrac4	single
Molfrac5	single
Molfrac6	single
Molfrac7	single
Molfrac8	single
Molfrac9	single
Name	string
Pk	string
Tk	string

Result Properties

No result properties found.

GRAV

Object Type: Gravitation

Properties

Name	Value Types
Beschx	single
Beschy	single
Beschz	single
InVariant	boolean
Jgrav	int32
Name	string
Pk	string

Result Properties

No result properties found.

GTXT

Object Type: Text

Properties

Name	Value Types
Angle	double
Beschreibung	string
ElementColor	color
ElementFont	c3sfont
Fkcont	string
GeometriesDiffer	boolean
Graftext	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

GVWK

Object Type: HeaterCooler

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dpnum	single
Eta	single
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string
bz.Inds	int32
bz.Sw	single

Result Properties

Name
EINAUS
IAKTIV
M
MAINELEMENT
P
PE
PI
PK
QN
TI
TK

HAUS

Object Type: House

Properties

Name	Value Types
DsnBundesweit	string
Fkfwvb	string
Fkknot	string
Fkstrasse	string
GeometriesDiffer	boolean
Graphics	hausverbgraf
Hausnr	int32
HausnrZus	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Plz	int32
SymbolFactor	double
Tk	string
TotalDemand	double
ViewX	double
ViewY	double
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

HYDR

Object Type: Hydrant

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
FkdtroRowd	string
Fkknot	string
Fkrohr	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
L	single
Name	string
Pk	string
Poskm	single
Rau	single
SymbolFactor	double
Tk	string
Typ	int32
Xkor	double
Ykor	double
Zeta	single
Zkor	single
bz.Fk	string
bz.Fkswvt	string
bz.Iaktiv	int32
bz.Indi	int32
bz.PhMin	single
bz.Phsoll	single
bz.Qmsoll	single

Result Properties

Name
BCTYP
IAKTIV
MAINELEMENT
PHR
PHR_ROHR
PHSOLL
PH_EINB
PH_ENTN
PH_MIN
QM
QSOLL
UV

KLAP

Object Type: FlapValve

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkphiv	string
Fkzep2	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Phie	single
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Te	single
Tk	string
Ts	single
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
DH
DP
DSI
DSK
FS
HR
IAKTIV
KV
M
MAINELEMENT
PHI
PHR
PR
QM
RHO
V
ZETA

KNOT

Object Type: Node

Properties

Name	Value Types
Beschreibung	string
Fk2lknot	string
Fkcont	string
Fkfqps	string
Fkfstf	string
Fkpzon	string
Fkutmp	string
GeometriesDiffer	boolean
HasBlockConnection	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Ktyp	string
Kvr	int32
KvrKlartext	string
Lfakt	single
Name	string
NodeNamePosition	int32
NumberOfVERB	int32
Pk	string
Qakt	double
QmEin	single
ShowNodeName	boolean
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
Zkor	single
bz.Drakonz	single
bz.Fk	string
bz.Fklfkt	string
bz.Fkpvar	string
bz.Fkqvar	string
bz.PhEin	single
bz.PhMin	single
bz.Te	single
bz.Tm	single

Result Properties

Name
BCIND
BCIND_CALC
BCIND_FLOW
BCIND_MODEL
BCIND_SOURCE
BCIND_TYPE
CHLORID
CP
DP
DPH
DYNVISKO
EH
EISENFILT
EISENGES
ESQUELLSP
FITT_ANGLE
FITT_BASTYPE
FITT_DP1
FITT_DP2
FITT_DP3
FITT_STATE
FITT_SUBTYPE
FITT_VBTYPE1
FITT_VBTYPE2
FITT_VBTYPE3
FITT_ZETA1
FITT_ZETA2
FITT_ZETA3
FSTF_NAME
GMIX_NAME
H
HI
HMAX_INST
HMIN_INST
HS
IAKTIV
INDUV
K
KP
KT
LEITFAEH
LFAKTAKT
LFKT
M
MAINELEMENT
MN
P
PDAMPF
PH
PHMINMAXDIF
PHWERT
PH_EIN
PH_MIN
PMAX_INST
PMIN_INST
PVAR
Q2
QM
QMABS
QVAR
RHO
RHON
RHONQUAL
SULFAT
T
TE
TEMP
TMAX_INST
TMIN_INST
TTR
VOLD
WALTER
ZHKNR

KOMK

Object Type: CompressorTable

Properties

Name	Value Types
Beschreibung	string
Etaps	single
Fkfstf	string
Idreferenz	string
InVariant	boolean
Name	string
Nmax	single
Nmin	single
Pansaug	single
Pk	string
Tansaug	single
Tk	string
Typ	int32
Zeitoption	int32

Result Properties

No result properties found.

KOMK_ROWS

Object Type: CompressorTable_Row

Properties

Name	Value Types
Etap	single
Fk	string
InVariant	boolean
N	single
Name	string
P	single
Pk	string
Q	single
Yp	single

Result Properties

No result properties found.

KOMP

Object Type: Compressor

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dndt	single
Dpdt	single
Dqndt	single
Etam	single
Etat	single
Fkantp	string
Fkcont	string
Fkkomk	string
GeometriesDiffer	boolean
Ibrenng	int32
Idreferenz	string
InVariant	boolean
Inda	int32
Iplanung	int32
Iprst	int32
Ipverh	int32
Name	string
Pk	string
PositionOfDescription	int32
Pverhdp	single
Pverhqn	single
ShowDescription	boolean
SymbolFactor	double
Tfahraus	single
Tfahrein	single
Tk	string
Xkor	double
Ykor	double
bz.Fk	string
bz.Inds	int32
bz.Sw	single

Result Properties

Name
DP
DT
EINAUS
ETAP
IAKTIV
IND
INDANT
M
MAINELEMENT
N
P
PE
PI
PK
PMAX
PRATIO
QN
QNBG
QNGES
TI
TK
YP

LAYR

Object Type: LAYR_Layer

Properties

Name	Value Types
Idreferenz	string
InVariant	boolean
Lfdnr	int32
Name	string
ObjsString	string
Pk	string
Setzen	int32
Tk	string
Zeigen	int32

Result Properties

No result properties found.

LFKT

Object Type: LoadFactorTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
FWVB_DPHMIN
FWVB_TVLMIN
LF
MAINELEMENT
MFVHYUV
MFVTHUV
NFVHYUV
NFVTHUV
TVMINMAX

LFKT_ROWT

Object Type: LoadFactorTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Lf	single
Name	string
Pk	string
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

LTGR

Object Type: PipeGroup

Properties

Name	Value Types
Beschreibung	string
Fksrat	string
InVariant	boolean
Name	string
Pk	string
Sichtbarkeit	int32
Tk	string
Verlegeart	int32

Result Properties

No result properties found.

MREG

Object Type: FlowControlUnit

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Dqdt	single
Fkcont	string
Fkzep1	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Tsig	single
Tvoll	single
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkswvtphi	string
bz.Fkswvtqm	string
bz.Indsoll	int32
bz.Phisoll	single
bz.Qmsoll	single

Result Properties

Name
DH
DP
DPH
DSI
DSK
FS
HR
IAKTIV
IND
KV
M
MAINELEMENT
PHI
PHISOLL
PR
Q
QM
QMSOLL
RHO
SWVTPHI
SWVTQM
V
ZETA

NRCV

Object Type: NumericalDisplay

Properties

Name	Value Types
Abswert	int32
Alarmcolor	int32
Angle	double
Attrtype	string
Beschreibung	string
BoundingRectangle	irectangle
Checkcolor	int32
Decpoint	int32
ElementAlarmColor	color
ElementFont	c3sfont
ElementNoticeColor	color
ElementWarnColor	color
Fkcont	string
FkdpgrDpkt	string
Fkobjtype	string
GeometriesDiffer	boolean
InVariant	boolean
Indval	int32
Name	string
Noticecolor	int32
Objtype	string
Pk	string
PrefixWidth	double
Prftxt	string
ResultValue	string
Thousandsep	int32
Tk	string
Unit	string
Warncolor	int32
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

NSCH

Object Type: NetValve

Properties

Name	Value Types
Beschreibung	string
Fkrohr	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Poskm	single
SymbolFactor	double
Tk	string
Typ	int32
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkswvt	string
bz.Indi	int32
bz.Stellung	int32

Result Properties

Name
MAINELEMENT
STELLUNG

OBEH

Object Type: OpenContainer

Properties

Name	Value Types
A	single
Angle	double
Beschreibung	string
Dn	single
Filling	int32
Fkatab	string
Fkcont	string
Fkfstf	string
Fkknotfilling	string
GeometriesDiffer	boolean
Hb	single
Idreferenz	string
InVariant	boolean
Indatab	int32
Iplanung	int32
Knotk	string
Name	string
Pk	string
SymbolFactor	double
SymbolGraf	symbol1c_graf
Tk	string
Xkor	double
Ykor	double
Zetaneg	single
Zetapos	single
Zkor	single
bz.Fk	string
bz.Tm0	single
bz.Walter0	single
bz.Wsp	single
bz.WspNN	double

Result Properties

Name
DWST_DT
IAKTIV
M
MAINELEMENT
MEXT
QM
QMEXT
RHO
T
T0
V
VOL
WALTER
WALTER0
WST
WST0

OVAL

Object Type: Oval

Properties

Name	Value Types
Beschreibung	string
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

PARI

Object Type: CalcPari

Properties

Name	Value Types
InVariant	boolean
Name	string
Nglopt	int32
Pk	string
bz.Epsp	single
bz.Epspreg	single
bz.Epsqm	single
bz.Epsqmreg	single
bz.Epst	single
bz.Epstrsp	single
bz.Fk	string
bz.Ntiter	int32
bz.Ntrspiter	int32
bz.Nziter	int32

Result Properties

No result properties found.

PARZ

Object Type: PARZ_TransientCalculationParameters

Properties

Name	Value Types
InVariant	boolean
Jdampf	int32
Jrst	int32
Name	string
Pk	string
Thepdk	single
Thepdr	single
bz.Dt	single
bz.Dttrsp	single
bz.Fk	string
bz.Tmax	single

Result Properties

No result properties found.

PGRP

Object Type: PumpGroup

Properties

Name	Value Types
ActAsa	int32
AusAsa	int32
Beschreibung	string
BoundingRectangle	irectangle
Dphaus	single
Fkcont	string
Fkkdmax	string
Fkkibyp	string
Fkkkbyp	string
Fkksmin	string
Ibyp	int32
Idreferenz	string
InVariant	boolean
Indrst	int32
Iplanung	int32
Ischalt	int32
Name	string
Nmax	single
Pdmax	single
Pk	string
Psmin	single
Qmaus	single
Tk	string
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkrart	string
bz.Iaktiv	int32
bz.Indpg	int32

Result Properties

Name
BK
DH
DP
DPH
ETA
IAKTIV
INDPG
INDSTD
IZSTPG
M
MAINELEMENT
NPUMPIST
NPUMPSOLL
PE
QM
RART
RHO
W
X

PGRP_PUMP

Object Type: PumpOfPumpGroup

Properties

Name	Value Types
Fkpgrp	string
Fkpump	string
InVariant	boolean
Iplanung	int32
Lfdnr	int32
Name	string
Pk	string
bz.Fk	string
bz.Iaktiv	int32

Result Properties

Name
IAKTIV
MAINELEMENT

PHI1

Object Type: ValveLiftTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
PHI

PHI1_ROWT

Object Type: ValveLiftTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Phi	single
Pk	string
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

PHI2

Object Type: VentOpenCloseTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

PHI2_ROWS

Object Type: VentOpenCloseTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Phio	single
Phis	single
Pk	string
Zeit	single

Result Properties

No result properties found.

PHIV

Object Type: NonReturnValvesTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string

Result Properties

No result properties found.

PHIV_ROWS

Object Type: NonReturnValvesTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Phi	single
Pk	string
V	single

Result Properties

No result properties found.

PHTR

Object Type: PhaseSeparation

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
Zeta	single
bz.Fk	string

Result Properties

Name
DH
DP
IAKTIV
MAINELEMENT
MI
MK
Q
QM
RHOI
RHOK
V

PLYG

Object Type: Polygon

Properties

Name	Value Types
Beschreibung	string
FillColor	color
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
LineColor	color
LineWidthMM	double
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

POLY

Object Type: Polyline

Properties

Name	Value Types
Beschreibung	string
DottedLine	int32
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
LineWidthMM	double
Name	string
Pk	string
Tk	string
bz.Fk	string

Result Properties

No result properties found.

PREG

Object Type: PressureRegulator

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkzep1	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Indprg	int32
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Ts	single
Typ	int32
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkswvt	string
bz.Indsoll	int32
bz.Phsoll	single

Result Properties

Name
DH
DP
DPH
DSI
DSK
FS
HR
IAKTIV
KV
M
MAINELEMENT
PH
PHI
PHSOLL
PR
PSOLL
QM
RHO
SWVT
V
ZETA

PUMD

Object Type: PumpSpeedTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
N

PUMD_ROWT

Object Type: PumpSpeedTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
N	single
Name	string
Pk	string
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

PUMK

Object Type: PumpCharTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
N	single
Name	string
Pk	string
Rhobzg	single
Tk	string
Typ	int32
Zeitoption	int32

Result Properties

No result properties found.

PUMK_ROWS

Object Type: PumpCharTable_Row

Properties

Name	Value Types
Eta	single
Fk	string
H	single
InVariant	boolean
Name	string
Npsh	single
P	single
Pk	string
Q	single

Result Properties

No result properties found.

PUMP

Object Type: Pump

Properties

Name	Value Types
Angle	double
BKFaktTubine	single
Beschreibung	string
Bkfak	single
Dndt	single
Dndtma	single
Dngross	single
Dnklein	single
Dt0aus	single
Dt0sch	single
Dt0std	single
EtaRef	nullable`1
EtaRefTurb	nullable`1
Etamot	single
Fkcont	string
Fketam	string
Fketar	string
Fketau	string
Fkkiapd	string
Fkkiaps	string
Fkkiasf	string
Fkkr1stf	string
Fkkr3std	string
Fkkr4std	string
Fkkref1	string
Fkkref2	string
Fkkrsspd	string
Fkkrssps	string
Fkpumk	string
Fkpumkturb	string
GeometriesDiffer	boolean
Href	single
Hrefturb	single
Idreferenz	string
Ifgsw	int32
InVariant	boolean
IndLTurb	int32
Indapd	int32
Indaps	int32
Indasf	int32
Indds	int32
Indl	int32
Indss	int32
Indstd	int32
Indstf	int32
Iplanung	int32
Jrlsp	int32
Jwirk	int32
Kdds	single
Kdss	single
Kdstd	single
Kdstf	single
Kids	single
Kiss	single
Kistd	single
Kistf	single
Kpds	single
Kpss	single
Kpstd	single
Kpstf	single
NMaxTurb	single
NMinTurb	single
Name	string
Nemot	single
Nmax	single
Nmin	single
Nref	single
Nrefturb	single
Ntrudel	single
Papd	single
Pdsein	single
PerformanceMapParameters	ipukennparams
Pk	string
PositionOfDescription	int32
Pref	single
Prefturb	single
Psa	single
Pssein	single
PukfString	string
Q0MaxTurb	single
Q0MinTurb	single
Q0max	single
Q0min	single
Qmref	single
Qmrefturb	single
Schlupf	single
ShowDescription	boolean
SymbolFactor	double
Tk	string
Totapd	single
Totaps	single
Totasf	single
Traeg	single
Tsig	single
Wirasf	int32
Wirstd	int32
Wirstf	int32
Wscasf	single
Wscstf	single
Wsostd	single
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkpumd	string
bz.Fkrcpl	string
bz.Fkswvt	string
bz.IndATurb	int32
bz.IndSTurb	int32
bz.Inda	int32
bz.IndaKlartext	string
bz.Inds	int32
bz.IndsKlartext	string
bz.Indturb	int32
bz.Ispu	int32
bz.IspuKlartext	string
bz.Isputurb	int32
bz.Nsoll	single
bz.Nsollturb	single
bz.Phsoll	single
bz.Qmsoll	single
bz.Qmsollturb	single
bz.Tipu	single

Result Properties

Name
BK
DH
DP
DPH
EINAUS
ETA
ETAW
IAKTIV
IND
M
MAINELEMENT
MOM
N
NMINMAXDIF
NPSH
NPSHDIF
NPSHMIN
NSOLLTURB
PA
PE
PE_RUECK
PHSOLL
PP
PUMD
QM
QMSOLL
QMSOLLTURB
QN0
RCPU_IND
RCPU_W
RCPU_X
RCPU_XD
RHO
STOERUNG
SWVT

PVAR

Object Type: VarPressureTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
PH

PVAR_ROWT

Object Type: VarPressureTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Ph	single
Pk	string
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

PZON

Object Type: PressureZone

Properties

Name	Value Types
Idimbh	int32
Idimra	int32
Idreferenz	string
InVariant	boolean
Klpmin	single
Lfdnr	int32
Modus	int32
Name	string
Pk	string
Pkmaxbh	single
Pkmaxra	single
Pkminbh	single
Pkminra	single
Tk	string

Result Properties

No result properties found.

QVAR

Object Type: VarFlowTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
FWVB_DPHMIN
FWVB_TVLMIN
MAINELEMENT
MFVHYUV
MFVTHUV
NFVHYUV
NFVTHUV
QM
TVMINMAX

QVAR_ROWT

Object Type: VarFlowTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pk	string
Qm	single
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

RADD

Object Type: SummingPoint

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Indadd	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE1
XE2

RART

Object Type: ControlMode

Properties

Name	Value Types
Beschreibung	string
Dwdt	single
Fkkref1	string
Fkkref2	string
Idreferenz	string
InVariant	boolean
Indstd	int32
Lfdnr	int32
Name	string
Pk	string
Tk	string
Tsig	single
TypeDescription	string
Xdein	single
bz.Fk	string
bz.Fkrcpl	string
bz.Fkswvt	string
bz.Wsostd	single

Result Properties

Name
MAINELEMENT
RCPL
SWVT
W

RCPL

Object Type: ControlPointTable

Properties

Name	Value Types
Aktiv	int32
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Typ	int32

Result Properties

Name
KNOT
MAINELEMENT
W
X
XD

RCPL_ROWT

Object Type: ControlPointTable_Row

Properties

Name	Value Types
Aktiv	int32
Fk	string
Fkkref1	string
Fkkref2	string
InVariant	boolean
Name	string
Pk	string
W	single

Result Properties

Name
MAINELEMENT
W
X
XD

RDIV

Object Type: Divider

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Inddiv	int32
Ka	string
Mindiv	single
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE1
XE2

RECT

Object Type: Rectangle

Properties

Name	Value Types
Beschreibung	string
FillColor	color
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
LineColor	color
LineWidthMM	double
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

REGP

Object Type: REGP_ControlParameters

Properties

Name	Value Types
Dt0reg	single
FlagsUser	int32
InVariant	boolean
Indreg	int32
Name	string
Pk	string

Result Properties

No result properties found.

REGV

Object Type: ControlValve

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkzep1	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
OnlStrgString	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Thub	single
Tk	string
Xkor	double
Ykor	double
bz.Fk	string
bz.Fkrart	string

Result Properties

Name
DH
DP
DPH
DSI
DSK
FS
HR
IAKTIV
INDSTD
KV
M
MAINELEMENT
PHI
PR
Q2
QM
RART
RHO
V
W
X
ZETA

RFKT

Object Type: FunctionGenerator

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
Fkcont	string
Fktfkt	string
InVariant	boolean
Indfkt	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string
bz.Fklfkt	string

Result Properties

Name
LFKT
MAINELEMENT
XA
XE

RHYS

Object Type: Histeresis

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
Fkcont	string
InVariant	boolean
Indhys	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Xo	single
Xstart	single
Xu	single
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE
XO
XU

RINT

Object Type: Integrator

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
Fkcont	string
InVariant	boolean
Ka	string
Name	string
Ogr	single
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Ugr	single
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE

RLSR

Object Type: LogicalStorage

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE1
XE2

RLVG

Object Type: LogicalComparison

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Indtyp	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE1
XE2

RMES

Object Type: Transmitter

Properties

Name	Value Types
Angle	double
Beschreibung	string
Fkcont	string
Idreferenz	string
InVariant	boolean
Indaggreg	int32
Indxbg	int32
Indxno	int32
Indxum	int32
Ka	string
Mesdt0	single
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Xmax	single
Xmin	single
Xumb	single
Xumm	single
Ykor	double
bz.Fk	string
bz.X0	single

Result Properties

Name
MAINELEMENT
XA
XM
XU

RMES_DPTS

Object Type: RMES_DPTS_RmesInternalDataPoint

Properties

Name	Value Types
Addend	single
AttributeDescription	string
Factor	single
Fkrmes	string
InVariant	boolean
Indfunc	int32
Lfdnr	int32
Name	string
ObjectTypeDescription	string
Pk	string
bz.Attrtype	string
bz.Fk	string
bz.Fkobjtype	string
bz.Objtype	string

Result Properties

No result properties found.

RMMA

Object Type: MinMaxSelection

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Indmma	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE1
XE2

RMUL

Object Type: Multiplier

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Indmul	int32
Ka	string
Konst	single
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
MULT
XA
XE1
XE2

ROHR

Object Type: Pipe

Properties

Name	Value Types
Asoll	single
Baujahr	string
Beschreibung	string
DN	string
Di	single
DottedLine	int32
Fk2lrohr	string
Fkcont	string
FkdtroRowd	string
Fkltgr	string
Fkstrasse	string
GeometriesDiffer	boolean
Hal	int32
HasClosedNSCHs	nullable`1
Idreferenz	string
InVariant	boolean
Indschall	int32
Iplanung	int32
Jlambs	int32
Kvr	int32
KvrKlartext	string
L	single
Lambda0	single
LineWidthMM	double
Lzu	single
Name	string
Pk	string
Rau	single
Tk	string
Xkor	double
Ykor	double
Zaus	single
Zein	single
Zuml	single
bz.Fk	string
bz.ITrennWithNSCH	int32
bz.Imptnz	single
bz.Irtrenn	int32
bz.Kantenzv	double
bz.Leckend	single
bz.Leckmenge	single
bz.Leckort	single
bz.Leckstart	single
bz.Leckstatus	int32
bz.Qsvb	single
bz.Zvlimptnz	double

Result Properties

Name
A
ACALC
CPI
CPK
DH
DP
DRAGRED
DRAKONZ
DSI
DSK
DTTR
DWVERL
DWVERLABS
ETAAV
FS
HR
HVEC
IAKTIV
IRTRENN
JV
JV2
LAMBDA
LECKEINAUS
LECKMENGE
LECKORT
LINEPACK
LINEPACKGEOM
LINEPACKRATE
MAINELEMENT
MAV
MI
MK
MKOND
MMAX_INST
MMIN_INST
MVEC
MVECMAX_INST
MVECMIN_INST
PAV
PDAMPF
PHR
PHVEC
PMAX
PMIN
PR
PVEC
PVECMAX_INST
PVECMIN_INST
QI2
QK2
QMAV
QMI
QMK
QMMAX_INST
QMMIN_INST
QMVEC
QSVB
RHOAV
RHOI
RHOK
RHOVEC
SVEC
TAV
TI
TK
TTRVEC
TVEC
TVECMAX_INST
TVECMIN_INST
VAV
VI
VK
VMAX_INST
VMIN_INST
VOLDA
WALTERI
WALTERK
WVL
ZAUS
ZEIN
ZHKNR
ZVEC

ROHR_VRTX

Object Type: PipeVertex

Properties

Name	Value Types
Fk	string
InVariant	boolean
Lfdnr	int32
Name	string
Pk	string
Xkor	double
Ykor	double
Zkor	single

Result Properties

Name
H
M
MAINELEMENT
MMAX_INST
MMIN_INST
P
PH
PMAX_INST
PMIN_INST
RHO
T
TMAX_INST
TMIN_INST

RPFL

Object Type: DirectionalArrow

Properties

Name	Value Types
Angle	double
Beschreibung	string
FillColor	color
Fkcont	string
FkdpgrDpkt	string
GeometriesDiffer	boolean
InVariant	boolean
Inddir	int32
LineColor	color
LineWidthMM	double
Name	string
Pk	string
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Eps	single
bz.Fk	string

Result Properties

No result properties found.

RPID

Object Type: PidController

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
E2	string
Fkcont	string
InVariant	boolean
Inddif	int32
Indein	int32
Indint	int32
Ka	string
Kd	single
Kp	single
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Td	single
Tk	string
Wirk	int32
Xdzul	single
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
DYDT
DYDTD
DYDTI
DYDTP
MAINELEMENT
XA
XE1
XE2

RPT1

Object Type: Pt1Controller

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
Fkcont	string
InVariant	boolean
Ka	string
Kp	single
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
T1	single
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE

RRCT

Object Type: RoundRectangle

Properties

Name	Value Types
Beschreibung	string
FillColor	color
Fkcont	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
LineColor	color
LineWidthMM	double
Name	string
Pk	string
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

RSLW

Object Type: SetpointDevice

Properties

Name	Value Types
Angle	double
Beschreibung	string
Fkcont	string
Idreferenz	string
InVariant	boolean
Indwbg	int32
Indwno	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Wmax	single
Wmin	single
Xkor	double
Ykor	double
bz.Fk	string
bz.Fklfkt	string
bz.Fkswvt	string
bz.Indslw	int32
bz.Slwkon	single

Result Properties

Name
LFKT
MAINELEMENT
SLWKON
SWVT
W
WAKT
WE
WEAKT
WERCK
WRCK
XA

RSTE

Object Type: ControlVariableConverterRSTE

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dsdt1	single
Dsdt2	single
Dsdt3	single
Dsdt4	single
Dsdt5	single
Fkcont	string
Fkvbel1	string
Fkvbel2	string
Fkvbel3	string
Fkvbel4	string
Fkvbel5	string
InVariant	boolean
Indyno1	int32
Indyno2	int32
Indyno3	int32
Indyno4	int32
Indyno5	int32
Ka	string
Kmes1i	string
Kmes1k	string
Kmes2i	string
Kmes2k	string
Kmes3i	string
Kmes3k	string
Kmes4i	string
Kmes4k	string
Kmes5i	string
Kmes5k	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Typ1	string
Typ2	string
Typ3	string
Typ4	string
Typ5	string
Xkor	double
Ykor	double
Ymax1	single
Ymax2	single
Ymax3	single
Ymax4	single
Ymax5	single
Ymin1	single
Ymin2	single
Ymin3	single
Ymin4	single
Ymin5	single
Ys11	single
Ys12	single
Ys13	single
Ys14	single
Ys15	single
Ys21	single
Ys22	single
Ys23	single
Ys24	single
Ys25	single
bz.Fk	string

Result Properties

Name
DYDT1
DYDT2
DYDT3
DYDT4
DYDT5
MAINELEMENT
XE1
YS1
YS2
YS3
YS4
YS5

RSTN

Object Type: ControlVariableConverter

Properties

Name	Value Types
AnalogInputE1	string
Angle	double
Beschreibung	string
Dsdt	single
Fkcont	string
Fkdprg	string
Fkfwes	string
Fkfwwu	string
Fkgvwk	string
Fkknot	string
Fkkomp	string
Fkmreg	string
Fkobeh	string
Fkpgrp	string
Fkpreg	string
Fkpump	string
Fkpumppg	string
Fkrart	string
Fkrartpg	string
Fkregv	string
Fkrohr	string
Fkvent	string
Idreferenz	string
InVariant	boolean
Indyno	int32
Ityp	int32
Ka	string
LogicalInputE2	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Typ	string
Xkor	double
Ykor	double
Ymax	single
Ymin	single
Ys1	single
Ys2	single
bz.Fk	string
bz.Fklfkt	string
bz.Fkphi1	string
bz.Fkpumd	string
bz.Fkpvar	string
bz.Fkqvar	string
bz.Fkrcpl	string
bz.FkrcplRowt	string
bz.Fkswvt	string
bz.Fktevt	string
bz.Fkwevt	string
bz.Iaktiv	int32

Result Properties

Name
LFKT
MAINELEMENT
PHI1
PUMD
PVAR
QVAR
SWVT
TEVT
TRGCOUNT
WEVT
XE1
XE2

RTOT

Object Type: DeadTimeElement

Properties

Name	Value Types
Angle	double
Beschreibung	string
E1	string
Fkcont	string
InVariant	boolean
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Ttot	single
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

Name
MAINELEMENT
XA
XE

RUES

Object Type: TransitionSymbol

Properties

Name	Value Types
Angle	double
Beschreibung	string
Fkcont	string
Idue	string
InVariant	boolean
InputRues	string
Iotyp	int32
Ka	string
Name	string
Pk	string
RglSymbolTyp	rglsymboltype
SymbolFactor	double
Tk	string
Xkor	double
Ykor	double
bz.Fk	string

Result Properties

No result properties found.

SIVE

Object Type: SafetyValve

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkkref	string
Fkphi2	string
Fkzep2	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Tk	string
Typ	int32
Xkor	double
Ykor	double
bz.Fk	string
bz.Phis	single
bz.Psch	single

Result Properties

Name
DH
DP
DPH
DSI
DSK
FS
HR
IAKTIV
M
MAINELEMENT
PHI
PHSCH
PR
QM
RHO
V
ZETA

SOKO

Object Type: SolarCollector

Properties

Name	Value Types
A1	single
A2	single
Apertfl	single
Beschreibung	string
Bruttfl	single
C1	single
C2	single
C3	single
Ceff	single
Eta0b	single
Eta0hem	single
Iamew00	single
Iamew10	single
Iamew20	single
Iamew30	single
Iamew40	single
Iamew50	single
Iamew60	single
Iamew70	single
Iamew80	single
Iamew90	single
Iamns00	single
Iamns10	single
Iamns20	single
Iamns30	single
Iamns40	single
Iamns50	single
Iamns60	single
Iamns70	single
Iamns80	single
Iamns90	single
Idreferenz	string
InVariant	boolean
Indfl	int32
Indiam	int32
Kthetad	single
Name	string
Pk	string
Tk	string
Typ	int32

Result Properties

No result properties found.

SPLZ

Object Type: SPLZ_TimeSeries

Properties

Name	Value Types
Aktiv	int32
InVariant	boolean
Lfdnr	int32
Name	string
Pk	string

Result Properties

No result properties found.

SRAT

Object Type: DamageRatesTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

SRAT_ROWS

Object Type: DamageRatesTable_Row

Properties

Name	Value Types
Erate	single
Fk	string
InVariant	boolean
Name	string
Pk	string
Ralter	int32
Srate	single

Result Properties

No result properties found.

STOF

Object Type: ThermophysPropTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

STOF_ROWS

Object Type: ThermophysPropTable_Row

Properties

Name	Value Types
Cp	single
Fk	string
InVariant	boolean
Lambda	single
Name	string
Nue	single
Pd	single
Pk	string
Rho	single
T	single

Result Properties

No result properties found.

STRASSE

Object Type: Street

Properties

Name	Value Types
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Name	string
Nummer	string
Ort	string
Ortsteil	string
Pk	string
Tk	string

Result Properties

No result properties found.

STRO

Object Type: StandPipe

Properties

Name	Value Types
A	single
Angle	double
Beschreibung	string
Dn	single
Fkatab	string
Fkcont	string
Fkfstf	string
GeometriesDiffer	boolean
Hb	single
Idreferenz	string
InVariant	boolean
Indatab	int32
Iplanung	int32
Knotk	string
Mue	single
Name	string
Pk	string
SymbolFactor	double
SymbolGraf	symbol1c_graf
Tk	string
U	single
Xkor	double
Ykor	double
Zetaneg	single
Zetapos	single
Zkor	single
bz.Fk	string

Result Properties

Name
IAKTIV
M
MAINELEMENT
MUEB
QM
QMUEB
RHO
T
V
VOL
WALTER
WST

SWVT

Object Type: MeasuredVariableTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
W

SWVT_ROWT

Object Type: MeasuredVariableTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pk	string
W	single
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

TEVT

Object Type: TemperatureTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
T

TEVT_ROWT

Object Type: TemperatureTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pk	string
T	single
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

TFKT

Object Type: FunctionTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

TFKT_ROWS

Object Type: FunctionTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pk	string
X	single
Y	single

Result Properties

No result properties found.

TRFT

Object Type: ReturnTemperaturTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
Zeitoption	int32

Result Properties

No result properties found.

TRFT_ROWS

Object Type: ReturnTemperaturTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Lfth	single
Name	string
Pk	string
Trs	single

Result Properties

No result properties found.

TRVA

Object Type: TransportVariable

Properties

Name	Value Types
InVariant	boolean
Jchlorid	int32
Jeisenfilt	int32
Jeisenges	int32
Jhi	int32
Jhs	int32
Jleitfaeh	int32
Jmn	int32
Jphwert	int32
Jqualpar	int32
Jrhon	int32
Jsulfat	int32
Jtemp	int32
Jtrsptyp	int32
Jwalter	int32
Name	string
Pk	string

Result Properties

No result properties found.

USCH

Object Type: USCH_UserDefinedProperties

Properties

Name	Value Types
Description	string
InVariant	boolean
Name	string
Objtype	string
Pk	string
Tk	string
Valtype	int32

Result Properties

No result properties found.

UTMP

Object Type: EnvironmentTemp

Properties

Name	Value Types
Idreferenz	string
InVariant	boolean
Name	string
Pk	string
Tk	string
bz.Fk	string
bz.Fktevt	string
bz.Fkwttr	string
bz.Indi	int32
bz.Tu	single

Result Properties

No result properties found.

VARA

Object Type: VARA_ColorScale

Properties

Name	Value Types
InVariant	boolean
Lfdnr	int32
Name	string
Pk	string
Showarrow	int32
Tk	string

Result Properties

No result properties found.

VARA_ROWS

Object Type: VARA_ROWS_WidthOrScale

Properties

Name	Value Types
Attype	string
Colormid	int32
Csvpfad	string
Cwend	single
Cwmode	int32
Cwstart	single
Cwtype	int32
Fk	string
Iabsvalue	int32
Icsvcolid	int32
Icsvcolval	int32
Icsvidprop	string
Iinvert	int32
InVariant	boolean
Name	string
Numcolor	int32
Pk	string
Prop	string
Proptype	int32
Reseletype	string
Tk	string
Valueconst	single
Valueend	single
Valuelb	single
Valuestart	single
Valueub	single

Result Properties

No result properties found.

VENT

Object Type: Valve

Properties

Name	Value Types
Angle	double
Beschreibung	string
Dn	single
Fkcont	string
Fkzep2	string
GeometriesDiffer	boolean
Idreferenz	string
InVariant	boolean
Indhub	int32
Indzeta	int32
IndzetaKlartext	string
Iplanung	int32
Name	string
Pk	string
PositionOfDescription	int32
ShowDescription	boolean
SymbolFactor	double
Thub	single
Thub1	single
Thub2	single
Tk	string
Tpaus	single
Tsig	single
Typ	int32
TypKlartext	string
Xkor	double
Ykor	double
Zetag	single
Zetaneg	single
Zetapos	single
bz.Fk	string
bz.Fkphi1	string
bz.IndPhiKonst	int32
bz.Indphi	int32
bz.IndphiKlartext	string
bz.Phig	single
bz.Phio	single
bz.Phisoll	single
bz.Tiv	single

Result Properties

Name
AUF
AUFZU
DH
DP
DSI
DSK
FREIGABE
FS
HR
IAKTIV
KV
LAEUFT
M
MAINELEMENT
OEFFNET
PHI
PHI1
PHR
PR
Q2
QM
RHO
SCHLIESST
STOERUNG
V
ZETA
ZU

VERB

Object Type: Demand

Properties

Name	Value Types
AenderungArt	int32
AenderungDatum	string
AenderungInfo	string
Betriebsstatus	int32
Betriebsstunden	single
Dimension	string
ErzeugungArt	int32
ErzeugungInfo	string
Fkhaus	string
GeometriesDiffer	boolean
Graphics	hausverbgraf
Hausanlagenbauart	string
Hausanlagentyp	string
Hausnr	int32
HausnrZus	string
Heizleistung	single
Idreferenz	string
InVariant	boolean
Jahresarbeit	single
Kuehlleistung	single
KundenId	string
Kundengruppe	string
LaengeHal	single
LaengeHauseinfuehrung	single
MengenbegrHwd	single
Name	string
Pk	string
Plz	int32
Prl	single
Pvl	single
Qhm	single
QhmaxFd	single
QhmaxFh	single
Rau	single
Sonstige	single
Spartentyp	string
Tariftyp	string
Tk	string
Trs0	single
Tvl0	single
Verbrauch	double
VerbrauchDatum	string
ViewX	double
ViewY	double
Warmwasserleistung	single
Xkor	double
Ykor	double
ZaehlerId	string
Zeta	single
Zkor	single
bz.Fk	string

Result Properties

No result properties found.

VKNO

Object Type: BlockConnectionNode

Properties

Name	Value Types
Displaymode	int32
Fkcont	string
Fkknot	string
InVariant	boolean
Name	string
Pk	string
Pointinsertx	double
Pointinserty	double
Posname	int32
Showname	int32
Symbolfact	single

Result Properties

No result properties found.

VRCT

Object Type: VRCT_ViewRectangle

Properties

Name	Value Types
InVariant	boolean
Lfdnr	int32
Name	string
Pk	string
XLinks	single
XRechts	single
YOben	single
YUnten	single

Result Properties

No result properties found.

WBLZ

Object Type: WBLZ_ThermalBalance

Properties

Name	Value Types
Aktiv	int32
Beschreibung	string
Idim	int32
Idreferenz	string
InVariant	boolean
Name	string
ObjsString	string
Pk	string
Tk	string
Typ	string

Result Properties

Name
MAINELEMENT
WES
WRAND
WSPEI
WSPEI_SP
WVB
WVB_0
WVB_W
WVB_XD
WVERL
WWU

WEVT

Object Type: ThermalOutputTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Name	string
Pk	string
Zeitoption	int32

Result Properties

Name
MAINELEMENT
W

WEVT_ROWT

Object Type: ThermalOutputTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Name	string
Pk	string
W	single
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

WIND

Object Type: AirVessel

Properties

Name	Value Types
A	single
Angle	double
Beschreibung	string
Dn	single
Fkatab	string
Fkcont	string
Fkfstf	string
GeometriesDiffer	boolean
Hb	single
Ibla	int32
Idreferenz	string
InVariant	boolean
Indatab	int32
Iplanung	int32
Knotk	string
Name	string
Pg0	single
Pk	string
Rgas	single
Rpoly	single
SymbolFactor	double
SymbolGraf	symbol1c_graf
Tgas	single
Tk	string
Vg0	single
Xkor	double
Ykor	double
Zetaneg	single
Zetapos	single
Zkor	single
bz.Fk	string

Result Properties

Name
HLUFT
IAKTIV
M
MAINELEMENT
PLUFT
QM
RHO
T
V
VOL
VOLDA
VOLGAS
WALTER
WST

WTTR

Object Type: WeatherDataTable

Properties

Name	Value Types
Albedo	single
Beschreibung	string
Idreferenz	string
InVariant	boolean
Intpol	int32
Lat	single
Lon	single
Name	string
Pk	string
Stdlon	single
Zeitoption	int32

Result Properties

Name
GDIFF
GGLOB
MAINELEMENT
TEMP
WIND

WTTR_ROWT

Object Type: WeatherDataTable_Row

Properties

Name	Value Types
Fk	string
Gdiff	single
Gglob	single
InVariant	boolean
Name	string
Pk	string
Temp	single
Wind	single
Zeit	single
Zeitstempel	string

Result Properties

No result properties found.

ZEP1

Object Type: RegulatorsTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Kvbzg	single
Name	string
Pk	string
Tk	string
Typ	int32
Zeitoption	int32

Result Properties

No result properties found.

ZEP1_ROWS

Object Type: RegulatorsTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Kvrel	single
Name	string
Phi	single
Pk	string
Zeta	single

Result Properties

No result properties found.

ZEP2

Object Type: CharacteristicLossTable

Properties

Name	Value Types
Beschreibung	string
Idreferenz	string
InVariant	boolean
Kvbzg	single
Name	string
Pk	string
Tk	string
Typ	int32
Zeitoption	int32

Result Properties

No result properties found.

ZEP2_ROWS

Object Type: CharacteristicLossTable_Row

Properties

Name	Value Types
Fk	string
InVariant	boolean
Kvrelneg	single
Kvrelpos	single
Name	string
Phi	single
Pk	string
Zetaneg	single
Zetapos	single

Result Properties

No result properties found.