...
Anchor HyWorksApiGRPC.getProperty HyWorksApiGRPC.getProperty HyWorksApiGRPC.
getProperty
(key)Get HYPERSIM property Refer to the following page of the documentation to find the properties names:
Parameters: key (str) – property key
Returns: HYPERSIM property
Return type: str
Raises: AssertionError – raises exception on error
Examples:
HyWorksApi.getProperty(“hyworks.hysim.extraTimeout”)
...
Anchor HyWorksApiGRPC.setProperty HyWorksApiGRPC.setProperty HyWorksApiGRPC.
setProperty
(key, value, save=False)Set HYPERSIM general property Refer to the following page of the documentation to find the properties names:
Parameters: key (str) – property key
value (str) – property value
save (bool) – save preferences for the next session
Returns: error value
Return type: bool
Raises: AssertionError – raises exception on error
Examples:
HyWorksApi.setProperty(“hyworks.hysim.extraTimeout”, “1200000”)
HyWorksApi.setProperty(“hyworks.hysim.extraTimeout”, “1800000”, True)
...
Anchor HyWorksApiGRPC.getPreference HyWorksApiGRPC.getPreference HyWorksApiGRPC.
getPreference
(prefName)Retrieve a model preference Refer to the following pages of the documentation to find the preference names:
<https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/149881158/Simulation+Settings>
<https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/150144430/Task+Manager+Summary+and+Preferences><https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/149979423/Preferences>
Parameters: prefName (str) – preference name
Returns: error value
Return type: int
Raises: AssertionError – raises exception on error
...
Anchor HyWorksApiGRPC.setPreference HyWorksApiGRPC.setPreference HyWorksApiGRPC.
setPreference
(prefName, value)Set a model preference to a specific value Refer to the following pages of the documentation to find the preference names:
<https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/149881158/Simulation+Settings>
<https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/150144430/Task+Manager+Summary+and+Preferences><https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/149979423/Preferences>
Parameters: prefName (str) – preference name
value (str) – preference value
Returns: error value
Return type: int
Raises: AssertionError – raises exception on error
...