Skip to content

Commit 8f58d08

Browse files
committed
Improve docstring for ModelicaSystem.getQuantities
1 parent 835a765 commit 8f58d08

1 file changed

Lines changed: 41 additions & 6 deletions

File tree

OMPython/ModelicaSystem.py

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -565,13 +565,48 @@ def xmlparse(self):
565565

566566
self.quantitiesList.append(scalar)
567567

568-
def getQuantities(self, names=None): # 3
568+
def getQuantities(self, names: Optional[str | list[str]] = None) -> list[dict]:
569569
"""
570-
This method returns list of dictionaries. It displays details of quantities such as name, value, changeable, and description, where changeable means if value for corresponding quantity name is changeable or not. It can be called :
571-
usage:
572-
>>> getQuantities()
573-
>>> getQuantities("Name1")
574-
>>> getQuantities(["Name1","Name2"])
570+
This method returns list of dictionaries. It displays details of
571+
quantities such as name, value, changeable, and description.
572+
573+
Examples:
574+
>>> mod.getQuantities()
575+
[
576+
{
577+
'alias': 'noAlias',
578+
'aliasvariable': None,
579+
'causality': 'local',
580+
'changeable': 'true',
581+
'description': None,
582+
'max': None,
583+
'min': None,
584+
'name': 'x',
585+
'start': '1.0',
586+
'unit': None,
587+
'variability': 'continuous',
588+
},
589+
{
590+
'name': 'der(x)',
591+
# ...
592+
},
593+
# ...
594+
]
595+
596+
>>> getQuantities("y")
597+
[{
598+
'name': 'y', # ...
599+
}]
600+
601+
>>> getQuantities(["y","x"])
602+
[
603+
{
604+
'name': 'y', # ...
605+
},
606+
{
607+
'name': 'x', # ...
608+
}
609+
]
575610
"""
576611
if names is None:
577612
return self.quantitiesList

0 commit comments

Comments
 (0)