Update PushLogQuantity and add value setter for user-defined logging scalars
#74
Conversation
…ogging pull. Co-authored-by: Andreas Klöckner <[email protected]>
| def set_value(self, value: Any) -> None: | ||
| """Set the logged quantity value.""" | ||
| raise NotImplementedError( | ||
| f"set_value not implemented for log quantity {self.name}." | ||
| ) |
There was a problem hiding this comment.
Is it avoidable to have set_value in the LogQuantity interface instead of only in PushLogQuantity? Having it breeds an expectation that every LogQuantity support it, which isn't right.
| @@ -867,12 +887,13 @@ def add_quantity(self, quantity: LogQuantity, interval: int = 1) -> None: | |||
| :param interval: interval (in time steps) when to gather this quantity. | |||
| """ | |||
|
|
|||
| def add_internal(name, unit, description, def_agg): | |||
| def add_internal(name, unit, description, def_agg, set_value=None): | |||
There was a problem hiding this comment.
Now that we're standardizing set_value in PushLogQuantity, I'm no longer sold on the value of passing in set_value.
| @@ -251,11 +262,18 @@ def __init__(self, dt: Optional[float], name: str, unit: str = None, | |||
|
|
|||
|
|
|||
| class PushLogQuantity(LogQuantity): | |||
| """A loggable scalar whose value can be updated. | |||
There was a problem hiding this comment.
This should comment a bit on how the LogQuantity interface is a "pull" model generically, and how this offers "push" capability over it. What happens to redundant "set" attempts? What if nothing is pushed in a cycle?
| @@ -1498,6 +1521,15 @@ def add_run_info(mgr: LogManager) -> None: | |||
| mgr.set_constant("date", strftime("%a, %d %b %Y %H:%M:%S %Z", localtime())) | |||
| mgr.set_constant("unixtime", time()) | |||
|
|
|||
|
|
|||
| def set_quantity_value(mgr: LogManager, name: str, value: Any) -> None: | |||
| """Set a the value of a named LogQuantity. | |||
There was a problem hiding this comment.
Should narrow this to erroring if that quantity is not a push quantity.
|
Unsubscribing... @-mention or request review once it's ready for a look or needs attention. |
This PR is a direct continuation of #69.
Examples have been updated to use the built-in
PushLogQuantityobject, and a simple value setter function (set_quantity_value) is importable which allows for explicit updating.