API Documentation

API Index

This index links to the detailed API descriptions below.

Core Functions

Core Methods: SIR3S_Model

Core Methods: SIR3S_View

Core Methods: SIR3S_ModelRepair

Mantle Methods: SIR3S_Model_Dataframes

Mantle Methods: SIR3S_Model_Alternative_Models

Mantle Methods: SIR3S_Model_Plotting

Mantle Methods: SIR3S_Model_Advanced_Operations

Utility Functions

Core

Created on Fri Nov 22 14:46:49 2024

@author: Nischal Giriyan

class sir3stoolkit.core.wrapper.DotNetEnumMeta(cls, bases, classdict, **kwargs)[source]: Bases: EnumType

sir3stoolkit.core.wrapper.Initialize_Toolkit(basePath: str | None = None)[source]

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

class sir3stoolkit.core.wrapper.SIR3S_Model[source]

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[source]

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[source]

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[source]

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[source]

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)[source]

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)[source]

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.

AllowSirMessageBox(bAllow: bool)[source]

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

Parameters:: bAllow – Allow/not allow
Returns:: None
Return type:: None
Description:: This is a wrapper method for AllowSirMessageBox() from toolkit

CloseModel(saveChangesBeforeClosing: bool) → bool[source]

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)[source]

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)[source]

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.

CreateModelRepair()[source]

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

DeleteElement(Tk: str)[source]

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)[source]

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)[source]

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()[source]

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()[source]

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)[source]

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()[source]

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()[source]

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

GetCourseOfHydraulicProfile(tkAgsn, uid) → hydraulicProfile[source]

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[source]

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.

GetElementInfo(Tk: str)[source]

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][source]

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

GetGeometryInformation(Tk: str) → str[source]

Extracts the geometry information 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[source]

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[source]

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()[source]

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][source]

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][source]

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][source]

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][source]

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()[source]

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[source]

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)[source]

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[source]

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.

GetResultProperties_from_elementKey(elementKey: str) → list[source]

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[source]

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][source]

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)[source]

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][source]

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

GetTableRows(tablePkTk: str)[source]

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.

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

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[source]

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[source]

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][source]

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.

InsertElement(ElementType, IdRef: str) → str[source]

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[source]

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)[source]

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)[source]

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)[source]

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()[source]

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()[source]

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.

SetCurrentTimeStamp(timestamp: str)[source]

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)[source]

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)[source]

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[source]

Sets the geometry information 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)[source]

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[source]

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

SetValue(Tk: str, propertyName: str, Value: str)[source]

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)[source]

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)[source]

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).

to_dotnet_enum(py_enum_member)[source]

to_python_enum(dotnet_enum_member, py_enum_type)[source]

class sir3stoolkit.core.wrapper.SIR3S_ModelRepair(model_instance)[source]

Bases: object

CheckRepairTool(toolName, tol, adjustnodes, nodeDegree)[source]

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)[source]

Executes the said repair tool

Parameters:

imr – IModelRepairMethod returned from CheckRepairTool()
table – intended table, e.g, “ROHR”

Returns:

None

Return type:

None

Description:

This is a wrapper method for ExecuteRepairTool() from toolkit

GetListOfRepairTool()[source]

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[source]

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)[source]

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[source]

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[source]

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)[source]

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[source]

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[source]

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)[source]

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[source]

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)[source]

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)[source]

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[source]

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)[source]

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)[source]

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)[source]

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[source]

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 – Absolute x-Coordinate of the numerical Displa (left)
dY (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[source]

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[source]

Method for inserting a new Text within a Container

Parameters:

tkCont (str) – The (tk) key of the Container to insert the Text in
x – Absolute x-Coordinate of the Text (left)

:type x np.float64 :param y: Absolute y-Coordinate of the Text (bottom) :type y: np.float64 :param color: The desired Color as RGB :type color: int :param textContent: The textual Content of the Text. Max 80 Characters :type textContent: str :param angle_degree: Angle in Degree :type angle_degree: np.float32 :param faceName: Face Name of the Font (max. 32 Characters). Entering a non-installed

Face Name will assume it to be ‘Arial’

Parameters:

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)[source]

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[source]

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)[source]

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()[source]

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)[source]

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()[source]

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()[source]

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][source]

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[source]

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[source]

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()[source]

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).

GetNumericalDisplayProperties(Tk: str) → numericalDisplayProperties[source]

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[source]

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[source]

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[source]

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.

MoveElementBy(Tk: str, dX: float64, dY: float64)[source]

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)[source]

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)[source]

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 – 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)[source]

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()[source]

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.

RemoveAllExternalVisualObjects()[source]

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()[source]

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()[source]

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)[source]

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)[source]

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)[source]

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)[source]

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)[source]

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)[source]

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)[source]

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)[source]

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[source]

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)[source]

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)[source]

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.

to_dotnet_enum(py_enum_member, py_enum_type)[source]

to_python_enum(dotnet_enum_member, py_enum_type)[source]

sir3stoolkit.core.wrapper.create_dotnet_enum(name: str, dotnet_enum: str, assembly_ext: str)[source]

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[source]

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)[source]

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)[source]

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)[source]

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][source]

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][source]

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][source]

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[source]

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 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 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][source]

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][source]: Returns SRID, SRID and combined String. For example: (‘25832’, ‘1571’, ‘25832-1571’)

get_dataframe_from_time_table(time_table_tk: str, value_col_name: str = None, flag_mapping: dict = None) → DataFrame[source]

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[source]

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][source]

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]]

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[source]

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)[source]

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[source]

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()[source]

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()[source]

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[source]

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)[source]

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[source]

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))[source]

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))[source]

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)[source]

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[source]

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]][source]

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[source]

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[source]

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]][source]

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[source]

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[source]

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[source]: Emit a legacy message with level inference.

sir3stoolkit.logging_utils.get_logger(name: str) → Logger[source]: Create/get module logger with a host-aware fallback print handler.

sir3stoolkit.logging_utils.get_process_executable_name() → str[source]: Get executable name of current process when available.

sir3stoolkit.logging_utils.get_process_executable_path() → str | None[source]: Get absolute path to current process executable when available.

sir3stoolkit.logging_utils.is_host_process() → bool[source]: Return True when running inside SirGraf host process.

Object Types, Properties, and Result Value Types

Note

Every property both model data and result will be returned as a python str. The value types are just internal and possible for type conversion. For result properties, most are convertable to float, with VEC properties being one big exception. Their conversion can be found in the generation of result dataframes in dataframes.py.

AGSN_HydraulicProfile

Properties

Name	Value Type
`Name`	`string`
`Lfdnr`	`int32`
`Aktiv`	`int32`
`AllNodesAndLinks`	dictionary`2
`ObjsString`	`string`
`MainWay`	`iagsnway`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

AirVessel

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Indatab`	`int32`
`A`	`single`
`Hb`	`single`
`Vg0`	`single`
`Pg0`	`single`
`Tgas`	`single`
`Fkatab`	`string`
`Dn`	`single`
`Zetapos`	`single`
`Zetaneg`	`single`
`Rgas`	`single`
`Rpoly`	`single`
`Ibla`	`int32`
`Knotk`	`string`
`Zkor`	`single`
`Fkfstf`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolGraf`	`symbol1c_graf`
`SymbolFactor`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`HLUFT`
`IAKTIV`
`M`
`MAINELEMENT`
`PLUFT`
`QM`
`RHO`
`T`
`V`
`VOL`
`VOLDA`
`VOLGAS`
`WALTER`
`WST`

Arrow

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`SymbolFactor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

Atmosphere

Properties

Name	Value Type
`Name`	`string`
`Patmos`	`single`
`Indbarf`	`int32`
`Tatmos`	`single`
`Rgas`	`single`
`Rpoly`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

BlockConnectionNode

Properties

Name	Value Type
`Name`	`string`
`Fkknot`	`string`
`Fkcont`	`string`
`Showname`	`int32`
`Posname`	`int32`
`Pointinsertx`	`double`
`Pointinserty`	`double`
`Symbolfact`	`single`
`Displaymode`	`int32`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

CalcPari

Properties

Name	Value Type
`Name`	`string`
`Nglopt`	`int32`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Epsp`	`single`
`bz.Epsqm`	`single`
`bz.Epst`	`single`
`bz.Epspreg`	`single`
`bz.Epsqmreg`	`single`
`bz.Epstrsp`	`single`
`bz.Ntrspiter`	`int32`
`bz.Nziter`	`int32`
`bz.Ntiter`	`int32`

Result Properties

No result properties found.

CharacteristicLossTable

Properties

Name	Value Type
`Name`	`string`
`Typ`	`int32`
`Kvbzg`	`single`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

CharacteristicLossTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Phi`	`single`
`Zetapos`	`single`
`Zetaneg`	`single`
`Kvrelpos`	`single`
`Kvrelneg`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

Circle

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`LineWidthMM`	`double`
`LineColor`	`color`
`FillColor`	`color`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

Compressor

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Fkkomk`	`string`
`Inda`	`int32`
`Etam`	`single`
`Tfahraus`	`single`
`Tfahrein`	`single`
`Dndt`	`single`
`Dqndt`	`single`
`Dpdt`	`single`
`Ipverh`	`int32`
`Pverhqn`	`single`
`Pverhdp`	`single`
`Etat`	`single`
`Ibrenng`	`int32`
`Iprst`	`int32`
`Fkantp`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Inds`	`int32`
`bz.Sw`	`single`

Result Properties

Name	Value Type
`DP`
`DT`
`EINAUS`
`ETAP`
`IAKTIV`
`IND`
`INDANT`
`M`
`MAINELEMENT`
`N`
`P`
`PE`
`PI`
`PK`	`string`
`PMAX`
`PRATIO`
`QN`
`QNBG`
`QNGES`
`TI`
`TK`	`string`
`YP`

CompressorTable

Properties

Name	Value Type
`Name`	`string`
`Typ`	`int32`
`Fkfstf`	`string`
`Tansaug`	`single`
`Pansaug`	`single`
`Nmax`	`single`
`Nmin`	`single`
`Etaps`	`single`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

CompressorTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`N`	`single`
`Q`	`single`
`Yp`	`single`
`P`	`single`
`Etap`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

ControlEngineeringNexus

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Idxke`	`int32`
`LineWidthMM`	`double`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

ControlMode

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Fkkref1`	`string`
`Fkkref2`	`string`
`Indstd`	`int32`
`Xdein`	`single`
`Tsig`	`single`
`Dwdt`	`single`
`Lfdnr`	`int32`
`Idreferenz`	`string`
`TypeDescription`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Fkswvt`	`string`
`bz.Fkrcpl`	`string`
`bz.Wsostd`	`single`

Result Properties

Name	Value Type
`MAINELEMENT`
`RCPL`
`SWVT`
`W`

ControlPointTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Aktiv`	`int32`
`Typ`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`KNOT`
`MAINELEMENT`
`W`
`X`
`XD`

ControlPointTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Fkkref1`	`string`
`Fkkref2`	`string`
`W`	`single`
`Aktiv`	`int32`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`W`	`single`
`X`
`XD`

ControlValve

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Fkzep1`	`string`
`Fkcont`	`string`
`Thub`	`single`
`Idreferenz`	`string`
`Iplanung`	`int32`
`OnlStrgString`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Fkrart`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`INDSTD`
`KV`
`M`
`MAINELEMENT`
`PHI`
`PR`
`Q2`
`QM`
`RART`
`RHO`
`V`
`W`
`X`
`ZETA`

ControlVariableConverter

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Ityp`	`int32`
`Typ`	`string`
`Ymin`	`single`
`Ymax`	`single`
`Ys1`	`single`
`Ys2`	`single`
`Indyno`	`int32`
`Dsdt`	`single`
`Fkvent`	`string`
`Fkpreg`	`string`
`Fkdprg`	`string`
`Fkmreg`	`string`
`Fkfwes`	`string`
`Fkfwwu`	`string`
`Fkrart`	`string`
`Fkpgrp`	`string`
`Fkregv`	`string`
`Fkknot`	`string`
`Fkrohr`	`string`
`Fkpump`	`string`
`Fkobeh`	`string`
`Fkkomp`	`string`
`Fkgvwk`	`string`
`Fkpumppg`	`string`
`Fkrartpg`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`AnalogInputE1`	`string`
`LogicalInputE2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`
`bz.Fklfkt`	`string`
`bz.Fkphi1`	`string`
`bz.Fkpumd`	`string`
`bz.Fktevt`	`string`
`bz.Fkwevt`	`string`
`bz.Fkswvt`	`string`
`bz.Fkpvar`	`string`
`bz.Fkqvar`	`string`
`bz.Fkrcpl`	`string`
`bz.FkrcplRowt`	`string`
`bz.Iaktiv`	`int32`

Result Properties

Name	Value Type
`LFKT`
`MAINELEMENT`
`PHI1`
`PUMD`
`PVAR`
`QVAR`
`SWVT`
`TEVT`
`TRGCOUNT`
`WEVT`
`XE1`
`XE2`

ControlVariableConverterRSTE

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Typ1`	`string`
`Kmes1i`	`string`
`Kmes1k`	`string`
`Ymin1`	`single`
`Ymax1`	`single`
`Ys11`	`single`
`Ys21`	`single`
`Indyno1`	`int32`
`Dsdt1`	`single`
`Fkvbel1`	`string`
`Typ2`	`string`
`Kmes2i`	`string`
`Kmes2k`	`string`
`Ymin2`	`single`
`Ymax2`	`single`
`Ys12`	`single`
`Ys22`	`single`
`Indyno2`	`int32`
`Dsdt2`	`single`
`Fkvbel2`	`string`
`Typ3`	`string`
`Kmes3i`	`string`
`Kmes3k`	`string`
`Ymin3`	`single`
`Ymax3`	`single`
`Ys13`	`single`
`Ys23`	`single`
`Indyno3`	`int32`
`Dsdt3`	`single`
`Fkvbel3`	`string`
`Typ4`	`string`
`Kmes4i`	`string`
`Kmes4k`	`string`
`Ymin4`	`single`
`Ymax4`	`single`
`Ys14`	`single`
`Ys24`	`single`
`Indyno4`	`int32`
`Dsdt4`	`single`
`Fkvbel4`	`string`
`Typ5`	`string`
`Kmes5i`	`string`
`Kmes5k`	`string`
`Ymin5`	`single`
`Ymax5`	`single`
`Ys15`	`single`
`Ys25`	`single`
`Indyno5`	`int32`
`Dsdt5`	`single`
`Fkvbel5`	`string`
`Fkcont`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`DYDT1`
`DYDT2`
`DYDT3`
`DYDT4`
`DYDT5`
`MAINELEMENT`
`XE1`
`YS1`
`YS2`
`YS3`
`YS4`
`YS5`

CrossSectionTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

CrossSectionTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Ordinate`	`single`
`Flaeche`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

DPGR_DPKT_DatapointDpgrConnection

Properties

Name	Value Type
`Name`	`string`
`Fkdpgr`	`string`
`Fkdpkt`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

DPGR_DataPointGroup

Properties

Name	Value Type
`Name`	`string`
`PermissionFlags`	`int32`
`Typ`	`int32`
`Dtfak`	`int32`
`OpcgroupName`	`string`
`OpcserverPath`	`string`
`Description`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.LocalUse`	`int32`
`bz.ExternalUse`	`int32`

Result Properties

No result properties found.

DPKT_Datapoint

Properties

Name	Value Type
`Name`	`string`
`Objtype`	`string`
`Attrtype`	`string`
`Epkz`	`int32`
`Title`	`string`
`Unit`	`string`
`Flags`	`int32`
`Ol3command`	`string`
`Datatype`	`string`
`Datalength`	`int32`
`Description`	`string`
`Name1`	`string`
`Name2`	`string`
`Name3`	`string`
`Fkobjtype`	`string`
`ClientId`	`string`
`OpcitemId`	`string`
`ClientFlags`	`int32`
`Factor`	`single`
`Addend`	`single`
`Deviation`	`single`
`LowerLimit`	`single`
`UpperLimit`	`single`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Name1`	`string`
`bz.Name2`	`string`
`bz.Name3`	`string`
`bz.Fkobjtype`	`string`
`bz.ClientId`	`string`
`bz.OpcitemId`	`string`
`bz.ClientFlags`	`int32`
`bz.Factor`	`single`
`bz.Addend`	`single`
`bz.Deviation`	`single`
`bz.CheckAll`	`int32`
`bz.CheckMsg`	`int32`
`bz.CheckAbs`	`int32`
`bz.LowerLimit`	`single`
`bz.UpperLimit`	`single`
`bz.LimitToler`	`single`

Result Properties

No result properties found.

DamageRatesTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

DamageRatesTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Ralter`	`int32`
`Srate`	`single`
`Erate`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

DeadTimeElement

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Ttot`	`single`
`Fkcont`	`string`
`E1`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE`

Demand

Properties

Name	Value Type
`Name`	`string`
`Betriebsstatus`	`int32`
`ErzeugungArt`	`int32`
`ErzeugungInfo`	`string`
`Verbrauch`	`double`
`VerbrauchDatum`	`string`
`Fkhaus`	`string`
`Zkor`	`single`
`ZaehlerId`	`string`
`KundenId`	`string`
`Dimension`	`string`
`Spartentyp`	`string`
`Kundengruppe`	`string`
`Tariftyp`	`string`
`Betriebsstunden`	`single`
`Jahresarbeit`	`single`
`Warmwasserleistung`	`single`
`Heizleistung`	`single`
`Kuehlleistung`	`single`
`Sonstige`	`single`
`Tvl0`	`single`
`Trs0`	`single`
`MengenbegrHwd`	`single`
`Hausanlagentyp`	`string`
`Hausanlagenbauart`	`string`
`Pvl`	`single`
`Prl`	`single`
`Qhm`	`single`
`QhmaxFh`	`single`
`QhmaxFd`	`single`
`LaengeHal`	`single`
`LaengeHauseinfuehrung`	`single`
`Rau`	`single`
`Zeta`	`single`
`Idreferenz`	`string`
`AenderungArt`	`int32`
`AenderungInfo`	`string`
`AenderungDatum`	`string`
`Hausnr`	`int32`
`HausnrZus`	`string`
`Plz`	`int32`
`ViewX`	`double`
`ViewY`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Graphics`	`hausverbgraf`
`bz.Fk`	`string`

Result Properties

No result properties found.

DifferentialRegulator

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Typ`	`int32`
`Fkkref1`	`string`
`Fkkref2`	`string`
`Fkzep1`	`string`
`Ts`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Fkswvt`	`string`
`bz.Dphsoll`	`single`
`bz.Indsoll`	`int32`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`DPHSOLL`
`DPSOLL`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`KV`
`M`
`MAINELEMENT`
`PHI`
`PR`
`QM`
`RHO`
`SWVT`
`V`
`ZETA`

DirectionalArrow

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`FkdpgrDpkt`	`string`
`Inddir`	`int32`
`Beschreibung`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`LineWidthMM`	`double`
`LineColor`	`color`
`FillColor`	`color`
`Xkor`	`double`
`Ykor`	`double`
`SymbolFactor`	`double`
`Angle`	`double`
`bz.Fk`	`string`
`bz.Eps`	`single`

Result Properties

No result properties found.

DistrictHeatingConsumer

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ind0`	`int32`
`W0`	`single`
`Qm0`	`single`
`Tvl0`	`single`
`Trs0`	`single`
`Lfk`	`single`
`Rho0`	`single`
`Dtmin`	`single`
`Indtr`	`int32`
`Trsk`	`single`
`Fktrft`	`string`
`A`	`single`
`B`	`single`
`C`	`single`
`Vtyp`	`int32`
`V0`	`single`
`P1soll`	`single`
`Dpvlmin`	`single`
`Fkzep1vl`	`string`
`Tsvl`	`single`
`Zevk`	`single`
`Dphaus`	`single`
`Dprlmin`	`single`
`Fkzep1rl`	`string`
`Tsrl`	`single`
`Imbg`	`int32`
`Irfv`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`CPM`	`double`
`NumberOfVERB`	`int32`
`IndtrKlartext`	`string`
`M0Estimated`	`single`
`W0Estimated`	`single`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Indlast`	`int32`
`bz.Indlfkt2`	`int32`
`bz.Fklfkt`	`string`
`bz.Fklfkt2`	`string`
`bz.Fkqvar`	`string`
`bz.Fktevt`	`string`
`bz.IndlastKlartext`	`string`

Result Properties

Name	Value Type
`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`	`string`
`TVMIN`
`W`
`WHYUV`
`WSOLL`
`WTHUV`

DistrictHeatingFeeder

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Zeta`	`single`
`Taus`	`single`
`Irueck`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Ihytyp`	`int32`
`bz.Ithtyp`	`int32`
`bz.Tkon`	`single`
`bz.Fktevt`	`string`
`bz.Wkon`	`single`
`bz.Fkwevt`	`string`
`bz.IhytypKlartext`	`string`
`bz.IthtypKlartext`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`IAKTIV`
`IHYTYP`
`ITHTYP`
`M`
`MAINELEMENT`
`QM`
`RHOI`
`RHOK`
`TEVT`
`TI`
`TK`	`string`
`TKON`
`V`
`W`
`W0`
`WEVT`
`WSOLL`

Divider

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Mindiv`	`single`
`Inddiv`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE1`
`XE2`

DriveEfficiencyTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

DriveEfficiencyTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Nzun0`	`single`
`Etam`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

DrivePowerTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

DrivePowerTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Tumg`	`single`
`Pamax`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

EBES_FeederGroups

Properties

Name	Value Type
`Name`	`string`
`Lfdnr`	`int32`
`Idreferenz`	`string`
`ObjsString`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Aktiv`	`int32`
`bz.Aktivqs`	`int32`
`bz.Versagensw`	`single`

Result Properties

No result properties found.

EfficiencyConverterTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

EfficiencyConverterTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Nzun0`	`single`
`Etafu`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

ElementQuery

Properties

Name	Value Type
`Name`	`string`
`Elementtype`	`string`
`Aktiv`	`int32`
`Lfdnr`	`int32`
`QueryStringAsString`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

EnergyRecoveryTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

EnergyRecoveryTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Nzun0`	`single`
`Etadt`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

EnvironmentTemp

Properties

Name	Value Type
`Name`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Indi`	`int32`
`bz.Tu`	`single`
`bz.Fktevt`	`string`
`bz.Fkwttr`	`string`

Result Properties

No result properties found.

FWBZ_DistrictHeatingReferenceValues

Properties

Name	Value Type
`Name`	`string`
`Lambdabzg`	`single`
`Rhobzg`	`single`
`Hgebzg`	`single`
`Ikotyp`	`int32`
`Vhausg`	`single`
`Ahausg`	`single`
`Arohr`	`single`
`Zerohr`	`single`
`Flfwvb`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

FlapValve

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Fkphiv`	`string`
`Fkzep2`	`string`
`Ts`	`single`
`Phie`	`single`
`Te`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`KV`
`M`
`MAINELEMENT`
`PHI`
`PHR`
`PR`
`QM`
`RHO`
`V`
`ZETA`

FlowControlUnit

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Fkzep1`	`string`
`Tsig`	`single`
`Dqdt`	`single`
`Tvoll`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Indsoll`	`int32`
`bz.Qmsoll`	`single`
`bz.Fkswvtqm`	`string`
`bz.Phisoll`	`single`
`bz.Fkswvtphi`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`IND`
`KV`
`M`
`MAINELEMENT`
`PHI`
`PHISOLL`
`PR`
`Q`
`QM`
`QMSOLL`
`RHO`
`SWVTPHI`
`SWVTQM`
`V`
`ZETA`

FluidQualityParamSet

Properties

Name	Value Type
`Name`	`string`
`Lfdnr`	`int32`
`Walter`	`single`
`Temp`	`single`
`Eisenges`	`single`
`Eisenfilt`	`single`
`Sulfat`	`single`
`Chlorid`	`single`
`Leitfaeh`	`single`
`Phwert`	`single`
`Hs`	`single`
`Hi`	`single`
`Rhon`	`single`
`Mn`	`int32`
`Indhs`	`int32`
`Indhi`	`int32`
`Indrhon`	`int32`
`Indmn`	`int32`
`Indtemp`	`int32`
`Indeisenges`	`int32`
`Indeisenfilt`	`int32`
`Indsulfat`	`int32`
`Indchlorid`	`int32`
`Indleitfaeh`	`int32`
`Indphwert`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Fkswvths`	`string`
`bz.Fkswvthi`	`string`
`bz.Fkswvtrhon`	`string`
`bz.Fkswvtmn`	`string`
`bz.Fkswvttemp`	`string`
`bz.Fkswvteisenges`	`string`
`bz.Fkswvteisenfilt`	`string`
`bz.Fkswvtsulfat`	`string`
`bz.Fkswvtchlorid`	`string`
`bz.Fkswvtleitfaeh`	`string`
`bz.Fkswvtphwert`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`SWVTCHLORID`
`SWVTEISENFILT`
`SWVTEISENGES`
`SWVTHI`
`SWVTHS`
`SWVTLEITFAEH`
`SWVTMN`
`SWVTPHWERT`
`SWVTRHON`
`SWVTSULFAT`
`SWVTTEMP`

FluidQualityParamSet_OS

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Fkswvths`	`string`
`Fkswvthi`	`string`
`Fkswvtrhon`	`string`
`Fkswvtmn`	`string`
`Fkswvttemp`	`string`
`Fkswvteisenges`	`string`
`Fkswvteisenfilt`	`string`
`Fkswvtsulfat`	`string`
`Fkswvtchlorid`	`string`
`Fkswvtleitfaeh`	`string`
`Fkswvtphwert`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

FluidThermalPropertyGroup

Properties

Name	Value Type
`Name`	`string`
`Fkstof`	`string`
`K`	`single`
`Eps`	`single`
`Fkgmix`	`string`
`Indstf`	`int32`
`Rhonorm`	`single`
`Tref`	`single`
`Pref`	`single`
`Dynvisko`	`single`
`Isotherm`	`single`
`Cp`	`single`
`Gkomp1`	`single`
`Gkomp2`	`single`
`Tabdnam`	`string`
`Dracoeffa`	`single`
`Dracoeffb`	`single`
`Dracoeffc`	`single`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

FreeDuct

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Cdim`	`string`
`T`	`single`
`Ualm`	`single`
`Uwarn`	`single`
`Owarn`	`single`
`Oalm`	`single`
`Showrect`	`int32`
`Showname`	`int32`
`Fkcont`	`string`
`ElementFont`	`c3sfont`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`BoundingRectangle`	`irectangle`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`
`bz.Fkwtab`	`string`
`bz.Wert`	`single`
`bz.Afakt`	`single`
`bz.Dy`	`single`
`bz.Dt`	`single`
`bz.Ityp`	`int32`

Result Properties

Name	Value Type
`MAINELEMENT`
`OA`
`OW`
`UA`
`UW`
`WERT`

FunctionGenerator

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Indfkt`	`int32`
`Fktfkt`	`string`
`Fkcont`	`string`
`E1`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`
`bz.Fklfkt`	`string`

Result Properties

Name	Value Type
`LFKT`
`MAINELEMENT`
`XA`
`XE`

FunctionTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

FunctionTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`X`	`single`
`Y`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

GasComponent

Properties

Name	Value Type
`Name`	`string`
`Formula`	`string`
`Lfdnr`	`int32`
`Molarmass`	`single`
`Hs`	`single`
`Hi`	`single`
`BwrA0`	`single`
`BwrB0`	`single`
`BwrC0`	`single`
`BwrA`	`single`
`BwrB`	`single`
`BwrC`	`single`
`BwrAlpha`	`single`
`BwrGamma`	`single`
`Zisocoef`	`single`
`CpicoefA`	`single`
`CpicoefB`	`single`
`CpicoefC`	`single`
`CpicoefD`	`single`
`CpicoefE`	`single`
`Tb`	`single`
`Pc`	`single`
`Tc`	`single`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

GasMixture

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Lfdnr`	`int32`
`Fkgkmp1`	`string`
`Molfrac1`	`single`
`Fkgkmp2`	`string`
`Molfrac2`	`single`
`Fkgkmp3`	`string`
`Molfrac3`	`single`
`Fkgkmp4`	`string`
`Molfrac4`	`single`
`Fkgkmp5`	`string`
`Molfrac5`	`single`
`Fkgkmp6`	`string`
`Molfrac6`	`single`
`Fkgkmp7`	`string`
`Molfrac7`	`single`
`Fkgkmp8`	`string`
`Molfrac8`	`single`
`Fkgkmp9`	`string`
`Molfrac9`	`single`
`Fkgkmp10`	`string`
`Molfrac10`	`single`
`Fkgkmp11`	`string`
`Molfrac11`	`single`
`Fkgkmp12`	`string`
`Molfrac12`	`single`
`Fkgkmp13`	`string`
`Molfrac13`	`single`
`Fkgkmp14`	`string`
`Molfrac14`	`single`
`Fkgkmp15`	`string`
`Molfrac15`	`single`
`Fkgkmp16`	`string`
`Molfrac16`	`single`
`Fkgkmp17`	`string`
`Molfrac17`	`single`
`Fkgkmp18`	`string`
`Molfrac18`	`single`
`Fkgkmp19`	`string`
`Molfrac19`	`single`
`Fkgkmp20`	`string`
`Molfrac20`	`single`
`Fkgkmp21`	`string`
`Molfrac21`	`single`
`Fkgkmp22`	`string`
`Molfrac22`	`single`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

GeneralSection

Properties

Name	Value Type
`Name`	`string`
`Idqm`	`int32`
`Idph`	`int32`
`Netztyp`	`int32`
`Forc`	`int32`
`Pfadol1`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Cdat`	`string`
`bz.Cuhr`	`string`
`bz.Czon`	`string`
`bz.Iart`	`int32`
`bz.ArtTh`	`int32`
`bz.Thfakt`	`int32`
`bz.Itrenn`	`int32`
`bz.ThStat`	`int32`
`bz.ThInst`	`int32`
`bz.Jwarn`	`int32`
`bz.Lfqsv`	`single`
`bz.Schwellqsig`	`single`
`bz.Knuvtyp`	`int32`
`bz.ValidAggr`	`int32`
`bz.CalcNetwork`	`int32`
`bz.Idra`	`int32`
`bz.CheckRes`	`int32`
`bz.CheckMod`	`int32`

Result Properties

Name	Value Type
`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`

Gravitation

Properties

Name	Value Type
`Name`	`string`
`Jgrav`	`int32`
`Beschx`	`single`
`Beschy`	`single`
`Beschz`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

HeatExchanger

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`W0`	`single`
`T1ein0`	`single`
`T1aus0`	`single`
`T2ein0`	`single`
`T2aus0`	`single`
`Dn`	`single`
`Dp10min`	`single`
`Inddprl`	`int32`
`Fkzep1rl`	`single`
`Tsrl`	`single`
`Dp20`	`single`
`Re0`	`single`
`Expert`	`int32`
`A`	`single`
`K`	`single`
`Alpha1`	`single`
`Alpha2`	`single`
`L1`	`single`
`L2`	`single`
`Indwue`	`int32`
`Kstrant`	`single`
`Fkfwvb`	`string`
`Fkfwes`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Einaus`	`int32`
`bz.Ithtyp`	`int32`
`bz.T2aus`	`single`
`bz.Fktevt`	`string`

Result Properties

Name	Value Type
`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`

HeatFeederConsumerStation

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Fkfwes`	`string`
`Fkfwvb`	`string`
`Fkpreg`	`string`
`Fkpump`	`string`
`Fkklap`	`string`
`Indusing`	`int32`
`Dn`	`single`
`Dpvb0min`	`single`
`Dpes0`	`single`
`PuQmref`	`single`
`PuNref`	`single`
`PuHref`	`single`
`PuPref`	`single`
`Volsp`	`single`
`HMantel`	`single`
`HWsOkDif`	`single`
`HDif`	`single`
`HBUkDif`	`single`
`RInnen`	`single`
`RDif`	`single`
`HWsMax`	`single`
`Dhbasis`	`single`
`UMantel`	`single`
`UBoden`	`single`
`Tob`	`single`
`Tu`	`single`
`Tdr`	`single`
`TrefMin`	`single`
`TtolEs`	`single`
`TtolVb`	`single`
`W0Sp`	`single`
`W0Es`	`single`
`Tsp0`	`single`
`Trl0`	`single`
`W0Vb`	`single`
`Tvl0`	`single`
`Trs0`	`single`
`Indtr`	`int32`
`Fktrft`	`string`
`Fksoko`	`string`
`Indtrack`	`int32`
`Medium`	`int32`
`Qfs`	`single`
`Tgrenz`	`single`
`Deta0bLost`	`single`
`Abrutto`	`single`
`Wcorr`	`single`
`Indrohr`	`int32`
`Vrv`	`single`
`Indrumg`	`int32`
`L`	`single`
`Di`	`single`
`Kr`	`single`
`Rd`	`single`
`Lambdad`	`single`
`Lambdae`	`single`
`He`	`single`
`KrKt`	`single`
`Tru`	`single`
`Indwt`	`int32`
`Dtwt`	`single`
`Indtset`	`int32`
`Gtmaxtset`	`single`
`Dtsett`	`single`
`PrDn`	`single`
`Fkzep1Pr`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`NodeNameI`	`string`
`NodeNameK`	`string`
`StorageType`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Einaus`	`int32`
`bz.IndsSp`	`int32`
`bz.ModeSp`	`int32`
`bz.Ithtyp`	`int32`
`bz.Indlast`	`int32`
`bz.Neigung`	`single`
`bz.Azimut`	`single`
`bz.Fkwttr`	`string`
`bz.FktevtEs`	`string`
`bz.FktevtRs`	`string`
`bz.FkwevtSp`	`string`
`bz.FkqvarSp`	`string`
`bz.FkwevtEs`	`string`
`bz.FkwevtVb`	`string`
`bz.Fklfkt`	`string`
`bz.Pvlmax`	`single`
`bz.Ppumax`	`single`
`bz.Indstagn`	`int32`
`bz.TzuMax`	`single`
`bz.TzuMin`	`single`
`bz.TspMin`	`single`
`bz.TrsMax`	`single`
`bz.W0SpMin`	`single`
`bz.Qsprel0`	`single`
`bz.HWsStart`	`single`
`bz.TobStart`	`single`
`bz.TuStart`	`single`
`bz.TtolEval`	`single`

Result Properties

Name	Value Type
`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`
`Q_PU`
`QM`
`QM_ES`
`QM_PR`
`QM_VB`
`QSP`
`QSPREL`
`QV_BODEN`
`QV_DR`
`QV_MANTEL`
`QV_TOTAL`
`T_KALT`
`T_MIX`
`T_WARM`
`TDIFFO`
`TDIFFU`
`TRL`
`TRS`
`TSP`
`TVEC`
`TVL`
`W`
`W_ES`
`W_FS`
`W_PR`
`W_RO`
`W_VB`
`WKOLL`

HeaterCooler

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Eta`	`single`
`Dpnum`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Inds`	`int32`
`bz.Sw`	`single`

Result Properties

Name	Value Type
`EINAUS`
`IAKTIV`
`M`
`MAINELEMENT`
`P`
`PE`
`PI`
`PK`	`string`
`QN`
`TI`
`TK`	`string`

Histeresis

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Xu`	`single`
`Xo`	`single`
`Xstart`	`single`
`Indhys`	`int32`
`Fkcont`	`string`
`E1`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE`
`XO`	`single`
`XU`	`single`

House

Properties

Name	Value Type
`Name`	`string`
`Fkstrasse`	`string`
`Fkknot`	`string`
`Fkfwvb`	`string`
`Hausnr`	`int32`
`HausnrZus`	`string`
`Plz`	`int32`
`DsnBundesweit`	`string`
`Idreferenz`	`string`
`TotalDemand`	`double`
`ViewX`	`double`
`ViewY`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolFactor`	`double`
`Graphics`	`hausverbgraf`
`bz.Fk`	`string`

Result Properties

No result properties found.

Hydrant

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Typ`	`int32`
`Zkor`	`single`
`Zeta`	`single`
`Dn`	`single`
`FkdtroRowd`	`string`
`L`	`single`
`Rau`	`single`
`Fkrohr`	`string`
`Poskm`	`single`
`Fkknot`	`string`
`Idreferenz`	`string`
`Xkor`	`double`
`Ykor`	`double`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Angle`	`double`
`SymbolFactor`	`double`
`bz.Fk`	`string`
`bz.Phsoll`	`single`
`bz.Qmsoll`	`single`
`bz.Indi`	`int32`
`bz.Iaktiv`	`int32`
`bz.Fkswvt`	`string`
`bz.PhMin`	`single`

Result Properties

Name	Value Type
`BCTYP`
`IAKTIV`
`MAINELEMENT`
`PH_EINB`
`PH_ENTN`
`PH_MIN`
`PHR`
`PHR_ROHR`
`PHSOLL`
`QM`
`QSOLL`
`UV`

Integrator

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Ugr`	`single`
`Ogr`	`single`
`Fkcont`	`string`
`E1`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE`

LAYR_Layer

Properties

Name	Value Type
`Name`	`string`
`Zeigen`	`int32`
`Setzen`	`int32`
`Lfdnr`	`int32`
`Idreferenz`	`string`
`ObjsString`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

LoadFactorTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`FWVB_DPHMIN`
`FWVB_TVLMIN`
`LF`
`MAINELEMENT`
`MFVHYUV`
`MFVTHUV`
`NFVHYUV`
`NFVTHUV`
`TVMINMAX`

LoadFactorTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`Lf`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

LogicalComparison

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Indtyp`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE1`
`XE2`

LogicalStorage

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE1`
`XE2`

MeasuredVariableTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`W`

MeasuredVariableTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`W`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

MinMaxSelection

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Indmma`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE1`
`XE2`

Multiplier

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Konst`	`single`
`Indmul`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`MULT`
`XA`
`XE1`
`XE2`

NetValve

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Typ`	`int32`
`Poskm`	`single`
`Fkrohr`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`SymbolFactor`	`double`
`bz.Fk`	`string`
`bz.Indi`	`int32`
`bz.Stellung`	`int32`
`bz.Fkswvt`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`STELLUNG`

Node

Properties

Name	Value Type
`Name`	`string`
`Ktyp`	`string`
`Zkor`	`single`
`QmEin`	`single`
`Lfakt`	`single`
`Fkpzon`	`string`
`Fkfstf`	`string`
`Fkutmp`	`string`
`Fkfqps`	`string`
`Fkcont`	`string`
`Fk2lknot`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Kvr`	`int32`
`Qakt`	`double`
`Xkor`	`double`
`Ykor`	`double`
`NodeNamePosition`	`int32`
`ShowNodeName`	`boolean`
`KvrKlartext`	`string`
`NumberOfVERB`	`int32`
`HasBlockConnection`	`boolean`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolFactor`	`double`
`bz.Drakonz`	`single`
`bz.Fk`	`string`
`bz.Fkpvar`	`string`
`bz.Fkqvar`	`string`
`bz.Fklfkt`	`string`
`bz.PhEin`	`single`
`bz.Tm`	`single`
`bz.Te`	`single`
`bz.PhMin`	`single`

Result Properties

Name	Value Type
`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`
`PH_EIN`
`PH_MIN`
`PHMINMAXDIF`
`PHWERT`
`PMAX_INST`
`PMIN_INST`
`PVAR`
`Q2`
`QM`
`QMABS`
`QVAR`
`RHO`
`RHON`
`RHONQUAL`
`SULFAT`
`T`
`TE`
`TEMP`
`TMAX_INST`
`TMIN_INST`
`TTR`
`VOLD`
`WALTER`
`ZHKNR`

NonReturnValvesTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

NonReturnValvesTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`V`	`single`
`Phi`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

NumericalDisplay

Properties

Name	Value Type
`Name`	`string`
`Unit`	`string`
`Decpoint`	`int32`
`Abswert`	`int32`
`Prftxt`	`string`
`FkdpgrDpkt`	`string`
`Fkcont`	`string`
`Warncolor`	`int32`
`Noticecolor`	`int32`
`Alarmcolor`	`int32`
`Thousandsep`	`int32`
`Checkcolor`	`int32`
`Beschreibung`	`string`
`Indval`	`int32`
`Objtype`	`string`
`Attrtype`	`string`
`Fkobjtype`	`string`
`ResultValue`	`string`
`PrefixWidth`	`double`
`ElementFont`	`c3sfont`
`ElementWarnColor`	`color`
`ElementNoticeColor`	`color`
`ElementAlarmColor`	`color`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`BoundingRectangle`	`irectangle`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

ObjectContainerSymbol

Properties

Name	Value Type
`Name`	`string`
`Id`	`int32`
`Idparent`	`int32`
`Lfdnr`	`int32`
`Idreferenz`	`string`
`SymbolType`	`ccontsymboltype`
`SymbolFont`	`c3sfont`
`PickingTolerance`	`double`
`MaximalNodeWidth`	`double`
`MaximalPipeWidth`	`double`
`MaximalVbelNselWidth`	`double`
`MeterPerPixel`	`double`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`BoundingRectangle`	`irectangle`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

OpenContainer

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Indatab`	`int32`
`A`	`single`
`Hb`	`single`
`Fkatab`	`string`
`Dn`	`single`
`Zetapos`	`single`
`Zetaneg`	`single`
`Knotk`	`string`
`Zkor`	`single`
`Fkfstf`	`string`
`Fkknotfilling`	`string`
`Filling`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolGraf`	`symbol1c_graf`
`SymbolFactor`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`
`bz.Wsp`	`single`
`bz.Walter0`	`single`
`bz.Tm0`	`single`
`bz.WspNN`	`double`

Result Properties

Name	Value Type
`DWST_DT`
`IAKTIV`
`M`
`MAINELEMENT`
`MEXT`
`QM`
`QMEXT`
`RHO`
`T`
`T0`
`V`
`VOL`
`WALTER`
`WALTER0`
`WST`
`WST0`

Oval

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

PARZ_TransientCalculationParameters

Properties

Name	Value Type
`Name`	`string`
`Jdampf`	`int32`
`Thepdk`	`single`
`Thepdr`	`single`
`Jrst`	`int32`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Dt`	`single`
`bz.Tmax`	`single`
`bz.Dttrsp`	`single`

Result Properties

No result properties found.

PhaseSeparation

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Zeta`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`IAKTIV`
`MAINELEMENT`
`MI`
`MK`
`Q`
`QM`
`RHOI`
`RHOK`
`V`

PidController

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Kp`	`single`
`Kd`	`single`
`Td`	`single`
`Xdzul`	`single`
`Indein`	`int32`
`Indint`	`int32`
`Inddif`	`int32`
`Wirk`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`DYDT`
`DYDTD`
`DYDTI`
`DYDTP`
`MAINELEMENT`
`XA`
`XE1`
`XE2`

Pipe

Properties

Name	Value Type
`Name`	`string`
`FkdtroRowd`	`string`
`Fkltgr`	`string`
`Fkstrasse`	`string`
`L`	`single`
`Lzu`	`single`
`Rau`	`single`
`Jlambs`	`int32`
`Lambda0`	`single`
`Zein`	`single`
`Zaus`	`single`
`Zuml`	`single`
`Asoll`	`single`
`Indschall`	`int32`
`Baujahr`	`string`
`Hal`	`int32`
`Fkcont`	`string`
`Fk2lrohr`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Kvr`	`int32`
`LineWidthMM`	`double`
`DottedLine`	`int32`
`DN`	`string`
`Di`	`single`
`KvrKlartext`	`string`
`HasClosedNSCHs`	nullable`1
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Qsvb`	`single`
`bz.Irtrenn`	`int32`
`bz.Leckstatus`	`int32`
`bz.Leckstart`	`single`
`bz.Leckend`	`single`
`bz.Leckort`	`single`
`bz.Leckmenge`	`single`
`bz.Imptnz`	`single`
`bz.Zvlimptnz`	`double`
`bz.Kantenzv`	`double`
`bz.ITrennWithNSCH`	`int32`

Result Properties

Name	Value Type
`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`	`string`
`TTRVEC`
`TVEC`
`TVECMAX_INST`
`TVECMIN_INST`
`VAV`
`VI`
`VK`
`VMAX_INST`
`VMIN_INST`
`VOLDA`
`WALTERI`
`WALTERK`
`WVL`
`ZAUS`	`single`
`ZEIN`	`single`
`ZHKNR`
`ZVEC`

PipeGroup

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Verlegeart`	`int32`
`Sichtbarkeit`	`int32`
`Fksrat`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

PipeTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Typ`	`string`
`E`	`single`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

PipeTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Dn`	`string`
`Di`	`single`
`Da`	`single`
`S`	`single`
`Wsteig`	`single`
`Wtiefe`	`single`
`Kt`	`single`
`Pn`	`single`
`Ausfallzeit`	`single`
`Reparatur`	`single`
`Rehabilitation`	`single`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

PipeVertex

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Xkor`	`double`
`Ykor`	`double`
`Zkor`	`single`
`Lfdnr`	`int32`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`H`
`M`
`MAINELEMENT`
`MMAX_INST`
`MMIN_INST`
`P`
`PH`
`PMAX_INST`
`PMIN_INST`
`RHO`
`T`
`TMAX_INST`
`TMIN_INST`

Polygon

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`LineWidthMM`	`double`
`LineColor`	`color`
`FillColor`	`color`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

Polyline

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`LineWidthMM`	`double`
`DottedLine`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`

Result Properties

No result properties found.

PressureRegulator

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dn`	`single`
`Typ`	`int32`
`Indprg`	`int32`
`Fkzep1`	`string`
`Ts`	`single`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Indsoll`	`int32`
`bz.Phsoll`	`single`
`bz.Fkswvt`	`string`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`KV`
`M`
`MAINELEMENT`
`PH`
`PHI`
`PHSOLL`
`PR`
`PSOLL`
`QM`
`RHO`
`SWVT`
`V`
`ZETA`

PressureZone

Properties

Name	Value Type
`Name`	`string`
`Lfdnr`	`int32`
`Modus`	`int32`
`Idimra`	`int32`
`Idimbh`	`int32`
`Pkminra`	`single`
`Pkmaxra`	`single`
`Pkminbh`	`single`
`Pkmaxbh`	`single`
`Klpmin`	`single`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

Pt1Controller

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Kp`	`single`
`T1`	`single`
`Fkcont`	`string`
`E1`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE`

Pump

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Fkpumk`	`string`
`Fkpumkturb`	`string`
`Qmref`	`single`
`Nref`	`single`
`Href`	`single`
`Pref`	`single`
`Qmrefturb`	`single`
`Nrefturb`	`single`
`Hrefturb`	`single`
`Prefturb`	`single`
`Nmin`	`single`
`Nmax`	`single`
`Q0min`	`single`
`Q0max`	`single`
`Fkkref1`	`string`
`Fkkref2`	`string`
`Jwirk`	`int32`
`Traeg`	`single`
`Jrlsp`	`int32`
`Dndtma`	`single`
`Indl`	`int32`
`Fketam`	`string`
`Fketau`	`string`
`Fketar`	`string`
`Nemot`	`single`
`Etamot`	`single`
`Schlupf`	`single`
`Bkfak`	`single`
`Tsig`	`single`
`Dndt`	`single`
`Ntrudel`	`single`
`Dngross`	`single`
`Dnklein`	`single`
`Dt0aus`	`single`
`Indasf`	`int32`
`Wscasf`	`single`
`Fkkiasf`	`string`
`Totasf`	`single`
`Wirasf`	`int32`
`Indaps`	`int32`
`Psa`	`single`
`Fkkiaps`	`string`
`Totaps`	`single`
`Indapd`	`int32`
`Papd`	`single`
`Fkkiapd`	`string`
`Totapd`	`single`
`Fkcont`	`string`
`Dt0sch`	`single`
`Indds`	`int32`
`Pdsein`	`single`
`Fkkrsspd`	`string`
`Kpds`	`single`
`Kids`	`single`
`Kdds`	`single`
`Indss`	`int32`
`Pssein`	`single`
`Fkkrssps`	`string`
`Kpss`	`single`
`Kiss`	`single`
`Kdss`	`single`
`Indstf`	`int32`
`Wscstf`	`single`
`Fkkr1stf`	`string`
`Wirstf`	`int32`
`Kpstf`	`single`
`Kistf`	`single`
`Kdstf`	`single`
`Indstd`	`int32`
`Ifgsw`	`int32`
`Wsostd`	`single`
`Fkkr3std`	`string`
`Fkkr4std`	`string`
`Wirstd`	`int32`
`Kpstd`	`single`
`Kistd`	`single`
`Kdstd`	`single`
`Dt0std`	`single`
`Idreferenz`	`string`
`Iplanung`	`int32`
`PerformanceMapParameters`	`ipukennparams`
`BKFaktTubine`	`single`
`EtaRef`	nullable`1
`EtaRefTurb`	nullable`1
`IndLTurb`	`int32`
`NMaxTurb`	`single`
`NMinTurb`	`single`
`Q0MaxTurb`	`single`
`Q0MinTurb`	`single`
`PukfString`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`ShowDescription`	`boolean`
`PositionOfDescription`	`int32`
`Angle`	`double`
`SymbolFactor`	`double`
`GeometriesDiffer`	`boolean`
`bz.Fk`	`string`
`bz.Inds`	`int32`
`bz.Indturb`	`int32`
`bz.Ispu`	`int32`
`bz.Isputurb`	`int32`
`bz.Qmsoll`	`single`
`bz.Nsoll`	`single`
`bz.Qmsollturb`	`single`
`bz.Nsollturb`	`single`
`bz.Phsoll`	`single`
`bz.Fkrcpl`	`string`
`bz.Inda`	`int32`
`bz.Tipu`	`single`
`bz.Fkpumd`	`string`
`bz.Fkswvt`	`string`
`bz.IndATurb`	`int32`
`bz.IndSTurb`	`int32`
`bz.IndsKlartext`	`string`
`bz.IndaKlartext`	`string`
`bz.IspuKlartext`	`string`

Result Properties

Name	Value Type
`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`

PumpCharTable

Properties

Name	Value Type
`Name`	`string`
`N`	`single`
`Typ`	`int32`
`Rhobzg`	`single`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

PumpCharTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Q`	`single`
`H`	`single`
`P`	`single`
`Eta`	`single`
`Npsh`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

PumpGroup

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ibyp`	`int32`
`ActAsa`	`int32`
`AusAsa`	`int32`
`Fkkibyp`	`string`
`Fkkkbyp`	`string`
`Ischalt`	`int32`
`Qmaus`	`single`
`Dphaus`	`single`
`Indrst`	`int32`
`Nmax`	`single`
`Pdmax`	`single`
`Fkkdmax`	`string`
`Psmin`	`single`
`Fkksmin`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Xkor`	`double`
`Ykor`	`double`
`BoundingRectangle`	`irectangle`
`bz.Fk`	`string`
`bz.Iaktiv`	`int32`
`bz.Indpg`	`int32`
`bz.Fkrart`	`string`

Result Properties

Name	Value Type
`BK`
`DH`
`DP`
`DPH`
`ETA`
`IAKTIV`
`INDPG`
`INDSTD`
`IZSTPG`
`M`
`MAINELEMENT`
`NPUMPIST`
`NPUMPSOLL`
`PE`
`QM`
`RART`
`RHO`
`W`
`X`

PumpOfPumpGroup

Properties

Name	Value Type
`Name`	`string`
`Fkpgrp`	`string`
`Fkpump`	`string`
`Lfdnr`	`int32`
`Iplanung`	`int32`
`Pk`	`string`
`InVariant`	`boolean`
`bz.Fk`	`string`
`bz.Iaktiv`	`int32`

Result Properties

Name	Value Type
`IAKTIV`
`MAINELEMENT`

PumpSpeedTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`N`

PumpSpeedTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`N`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`DH`
`DP`
`DPH`
`DSI`
`DSK`
`FS`
`HR`
`IAKTIV`
`M`
`MAINELEMENT`
`PHI`
`PHSCH`
`PR`
`QM`
`RHO`
`V`
`ZETA`

SetpointDevice

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Wmin`	`single`
`Wmax`	`single`
`Indwbg`	`int32`
`Indwno`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`
`bz.Indslw`	`int32`
`bz.Slwkon`	`single`
`bz.Fkswvt`	`string`
`bz.Fklfkt`	`string`

Result Properties

Name	Value Type
`LFKT`
`MAINELEMENT`
`SLWKON`
`SWVT`
`W`
`WAKT`
`WE`
`WEAKT`
`WERCK`
`WRCK`
`XA`

SolarCollector

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Typ`	`int32`
`Bruttfl`	`single`
`Apertfl`	`single`
`Indfl`	`int32`
`Eta0hem`	`single`
`A1`	`single`
`A2`	`single`
`Eta0b`	`single`
`C1`	`single`
`C2`	`single`
`C3`	`single`
`Kthetad`	`single`
`Ceff`	`single`
`Indiam`	`int32`
`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`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

StandPipe

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Indatab`	`int32`
`A`	`single`
`Hb`	`single`
`U`	`single`
`Mue`	`single`
`Fkatab`	`string`
`Dn`	`single`
`Zetapos`	`single`
`Zetaneg`	`single`
`Knotk`	`string`
`Zkor`	`single`
`Fkfstf`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolGraf`	`symbol1c_graf`
`SymbolFactor`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`IAKTIV`
`M`
`MAINELEMENT`
`MUEB`
`QM`
`QMUEB`
`RHO`
`T`
`V`
`VOL`
`WALTER`
`WST`

Street

Properties

Name	Value Type
`Name`	`string`
`Nummer`	`string`
`Ort`	`string`
`Ortsteil`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`

Result Properties

No result properties found.

SummingPoint

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Indadd`	`int32`
`Fkcont`	`string`
`E1`	`string`
`E2`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XE1`
`XE2`

SwitchInBlock

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Fkblock`	`string`
`Fkcont`	`string`
`TextColor`	`color`
`ElementFont`	`c3sfont`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`BoundingRectangle`	`irectangle`
`Xkor`	`double`
`Ykor`	`double`

Result Properties

No result properties found.

TemperatureTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`T`

TemperatureTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`T`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

Text

Properties

Name	Value Type
`Name`	`string`
`Fkcont`	`string`
`Graftext`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`ElementColor`	`color`
`ElementFont`	`c3sfont`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

ThermalOutputTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`W`

ThermalOutputTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`W`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

ThermophysPropTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

ThermophysPropTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`T`	`single`
`Rho`	`single`
`Nue`	`single`
`Pd`	`single`
`Cp`	`single`
`Lambda`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

TransitionSymbol

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Iotyp`	`int32`
`Idue`	`string`
`Fkcont`	`string`
`InputRues`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Ka`	`string`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`

Result Properties

No result properties found.

Transmitter

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Ka`	`string`
`Mesdt0`	`single`
`Indaggreg`	`int32`
`Xumm`	`single`
`Xumb`	`single`
`Indxum`	`int32`
`Xmin`	`single`
`Xmax`	`single`
`Indxbg`	`int32`
`Indxno`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`RglSymbolTyp`	`rglsymboltype`
`SymbolFactor`	`double`
`Angle`	`double`
`Xkor`	`double`
`Ykor`	`double`
`bz.Fk`	`string`
`bz.X0`	`single`

Result Properties

Name	Value Type
`MAINELEMENT`
`XA`
`XM`
`XU`

TransportVariable

Properties

Name	Value Type
`Name`	`string`
`Jqualpar`	`int32`
`Jtrsptyp`	`int32`
`Jwalter`	`int32`
`Jtemp`	`int32`
`Jeisenges`	`int32`
`Jeisenfilt`	`int32`
`Jsulfat`	`int32`
`Jchlorid`	`int32`
`Jleitfaeh`	`int32`
`Jphwert`	`int32`
`Jhs`	`int32`
`Jhi`	`int32`
`Jrhon`	`int32`
`Jmn`	`int32`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

USCH_UserDefinedProperties

Properties

Name	Value Type
`Name`	`string`
`Objtype`	`string`
`Valtype`	`int32`
`Description`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`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`

ValveLiftTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`PHI`

ValveLiftTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`Phi`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

VarFlowTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`FWVB_DPHMIN`
`FWVB_TVLMIN`
`MAINELEMENT`
`MFVHYUV`
`MFVTHUV`
`NFVHYUV`
`NFVTHUV`
`QM`
`TVMINMAX`

VarFlowTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`Qm`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

VarPressureTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`PH`

VarPressureTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`Ph`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

VentOpenCloseTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Idreferenz`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`Zeitoption`	`int32`

Result Properties

No result properties found.

VentOpenCloseTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Phio`	`single`
`Phis`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.

VentValve

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Dgr`	`single`
`Dkl`	`single`
`Alpha`	`single`
`Vgrest`	`single`
`Qlbmax`	`single`
`Qlekl`	`single`
`Rgbeve`	`single`
`Trohr`	`single`
`Poeff`	`single`
`Ibedef`	`int32`
`Ibetyp`	`int32`
`Knotk`	`string`
`Zkor`	`single`
`Fkfstf`	`string`
`Iekl`	`int32`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolGraf`	`symbol1c_graf`
`SymbolFactor`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`IAKTIV`
`IND`
`M`
`MAINELEMENT`
`MLUFT`
`PHI`
`PLUFT`
`QLUFT`
`QM`
`QMLUFT`
`RHO`
`TLUFT`
`VLUFT`
`VOLLUFT`

VentilatedPressureAirVessel

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Indatab`	`int32`
`A`	`single`
`Lta`	`single`
`Hb`	`single`
`Pg0`	`single`
`Tgas`	`single`
`Fkatab`	`string`
`Dn`	`single`
`Zetapos`	`single`
`Zetaneg`	`single`
`Rgas`	`single`
`Rpoly`	`single`
`Knotk`	`string`
`Zkor`	`single`
`Fkfstf`	`string`
`Fkcont`	`string`
`Idreferenz`	`string`
`Iplanung`	`int32`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`
`GeometriesDiffer`	`boolean`
`SymbolGraf`	`symbol1c_graf`
`SymbolFactor`	`double`
`Xkor`	`double`
`Ykor`	`double`
`Angle`	`double`
`bz.Fk`	`string`

Result Properties

Name	Value Type
`HLUFT`
`IAKTIV`
`IND`
`M`
`MAINELEMENT`
`PLUFT`
`QM`
`RHO`
`T`
`TLUFT`
`V`
`VOL`
`VOLLUFT`
`VOLLUFT1`
`WALTER`
`WST`

WBLZ_ThermalBalance

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Typ`	`string`
`Aktiv`	`int32`
`Idim`	`int32`
`Idreferenz`	`string`
`ObjsString`	`string`
`Tk`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`MAINELEMENT`
`WES`
`WRAND`
`WSPEI`
`WSPEI_SP`
`WVB`
`WVB_0`
`WVB_W`
`WVB_XD`
`WVERL`
`WWU`

WeatherDataTable

Properties

Name	Value Type
`Name`	`string`
`Beschreibung`	`string`
`Stdlon`	`single`
`Lon`	`single`
`Lat`	`single`
`Albedo`	`single`
`Zeitoption`	`int32`
`Intpol`	`int32`
`Idreferenz`	`string`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

Name	Value Type
`GDIFF`
`GGLOB`
`MAINELEMENT`
`TEMP`
`WIND`

WeatherDataTable_Row

Properties

Name	Value Type
`Name`	`string`
`Fk`	`string`
`Zeit`	`single`
`Zeitstempel`	`string`
`Temp`	`single`
`Wind`	`single`
`Gglob`	`single`
`Gdiff`	`single`
`Pk`	`string`
`InVariant`	`boolean`

Result Properties

No result properties found.