Skip to content

ModelicaSystem - remove xml_file as class variable #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 30 additions & 18 deletions OMPython/ModelicaSystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,6 @@ def __init__(
if not isinstance(lmodel, list):
raise ModelicaSystemError(f"Invalid input type for lmodel: {type(lmodel)} - list expected!")

self._xml_file = None
self._lmodel = lmodel # may be needed if model is derived from other model
self._model_name = modelName # Model class name
self._file_name = pathlib.Path(fileName).resolve() if fileName is not None else None # Model file/package name
Expand Down Expand Up @@ -480,8 +479,8 @@ def buildModel(self, variableFilter: Optional[str] = None):
buildModelResult = self._requestApi("buildModel", self._model_name, properties=varFilter)
logger.debug("OM model build result: %s", buildModelResult)

self._xml_file = pathlib.Path(buildModelResult[0]).parent / buildModelResult[1]
self._xmlparse()
xml_file = pathlib.Path(buildModelResult[0]).parent / buildModelResult[1]
self._xmlparse(xml_file=xml_file)

def sendExpression(self, expr: str, parsed: bool = True):
try:
Expand All @@ -507,30 +506,42 @@ def _requestApi(self, apiName, entity=None, properties=None): # 2

return self.sendExpression(exp)

def _xmlparse(self):
if not self._xml_file.is_file():
raise ModelicaSystemError(f"XML file not generated: {self._xml_file}")
def _xmlparse(self, xml_file: pathlib.Path):
if not xml_file.is_file():
raise ModelicaSystemError(f"XML file not generated: {xml_file}")

tree = ET.parse(self._xml_file)
xml_content = xml_file.read_text()
tree = ET.ElementTree(ET.fromstring(xml_content))
rootCQ = tree.getroot()
for attr in rootCQ.iter('DefaultExperiment'):
for key in ("startTime", "stopTime", "stepSize", "tolerance",
"solver", "outputFormat"):
self._simulate_options[key] = attr.get(key)
self._simulate_options[key] = str(attr.get(key))

for sv in rootCQ.iter('ScalarVariable'):
scalar = {}
for key in ("name", "description", "variability", "causality", "alias"):
scalar[key] = sv.get(key)
scalar["changeable"] = sv.get('isValueChangeable')
scalar["aliasvariable"] = sv.get('aliasVariable')
translations = {
"alias": "alias",
"aliasvariable": "aliasVariable",
"causality": "causality",
"changeable": "isValueChangeable",
"description": "description",
"name": "name",
"variability": "variability",
}

scalar: dict[str, Any] = {}
for key_dst, key_src in translations.items():
val = sv.get(key_src)
scalar[key_dst] = None if val is None else str(val)

ch = list(sv)
for att in ch:
scalar["start"] = att.get('start')
scalar["min"] = att.get('min')
scalar["max"] = att.get('max')
scalar["unit"] = att.get('unit')

# save parameters in the corresponding class variables
if scalar["variability"] == "parameter":
if scalar["name"] in self._override_variables:
self._params[scalar["name"]] = self._override_variables[scalar["name"]]
Expand Down Expand Up @@ -1535,7 +1546,8 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
compatibility, because linearize() used to return `[A, B, C, D]`.
"""

if self._xml_file is None:
if len(self._quantities) == 0:
# if self._quantities has no content, the xml file was not parsed; see self._xmlparse()
raise ModelicaSystemError(
"Linearization cannot be performed as the model is not build, "
"use ModelicaSystem() to build the model first"
Expand All @@ -1546,10 +1558,10 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
overrideLinearFile = self._tempdir / f'{self._model_name}_override_linear.txt'

with open(file=overrideLinearFile, mode="w", encoding="utf-8") as fh:
for key, value in self._override_variables.items():
fh.write(f"{key}={value}\n")
for key, value in self._linearization_options.items():
fh.write(f"{key}={value}\n")
for key1, value1 in self._override_variables.items():
fh.write(f"{key1}={value1}\n")
for key2, value2 in self._linearization_options.items():
fh.write(f"{key2}={value2}\n")

om_cmd.arg_set(key="overrideFile", val=overrideLinearFile.as_posix())

Expand Down
Loading