Description: "Package with functions that call Python"

- Home > Modelica

## Buildings.Utilities.IO.Python27.Functions.BaseClasses

Package with functions that call Python

### Information

This package contains functions that call Python.

Extends from Modelica.Icons.BasesPackage (Icon for packages containing base classes).

### Package Content

Name | Description
--- | ---
exchange | Function that communicates with Python

## Buildings.Utilities.IO.Python27.Functions.BaseClasses.exchange

Function that communicates with Python

### Information

This function exchanges data with Python. See Buildings.Utilities.IO.Python27.UsersGuide for instructions, and Buildings.Utilities.IO.Python27.Functions.Examples for examples.

### Inputs

Type | Name | Default | Description
--- | --- | --- | ---
String | moduleName |  | Name of the python module that contains the function
String | functionName | moduleName | Name of the python function
Real | dblWri[max(1, nDblWri)] |  | Double values to write
Integer | intWri[max(1, nIntWri)] |  | Integer values to write
String | strWri[max(1, nStrWri)] |  | String values to write
Integer | nDblWri |  | Number of double values to write
Integer | nDblRea |  | Number of double values to read
Integer | nIntWri |  | Number of integer values to write
Integer | nIntRea |  | Number of integer values to read
Integer | nStrWri |  | Number of strings to write

### Outputs

Type | Name | Description
--- | --- | ---
Real | dblRea[max(1, nDblRea)] | Double values returned by Python
Integer | intRea[max(1, nIntRea)] | Integer values returned by Python

### Modelica definition

function exchange "Function that communicates with Python" input String moduleName "Name of the python module that contains the function"; input String functionName=moduleName "Name of the python function"; input Real dblWri[max(1, nDblWri)] "Double values to write"; input Integer intWri[max(1, nIntWri)] "Integer values to write"; input String strWri[max(1, nStrWri)] "String values to write"; input Integer nDblWri(min=0) "Number of double values to write"; input Integer nDblRea(min=0) "Number of double values to read"; input Integer nIntWri(min=0) "Number of integer values to write"; input Integer nIntRea(min=0) "Number of integer values to read"; input Integer nStrWri(min=0) "Number of strings to write"; // input Integer nStrRea(min=0) "Number of strings to read"; // input Integer strLenRea(min=0) // "Maximum length of each string that is read. If exceeded, the simulation stops with an error"; output Real dblRea[max(1, nDblRea)] "Double values returned by Python"; output Integer intRea[max(1, nIntRea)] "Integer values returned by Python"; external "C" pythonExchangeValues(moduleName, functionName, dblWri, nDblWri, dblRea, nDblRea, intWri, nIntWri, intRea, nIntRea, strWri, nStrWri); end exchange;