Draft of formula data record #302
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #302 +/- ##
===========================================
- Coverage 100.00% 97.50% -2.50%
===========================================
Files 49 50 +1
Lines 2890 2966 +76
Branches 356 358 +2
===========================================
+ Hits 2890 2892 +2
- Misses 0 74 +74
|
| def contains(self) -> Tuple["AbstractDataRecord", ...]: | ||
| return () | ||
|
|
||
| def decode(self, raw_value: int) -> float: |
There was a problem hiding this comment.
please adjust the code to handle following scenario:
raw_value | physical_value
0 | 0 km/h (decoding/encoding using encode/decode function)
1 | 0.1 km/h (decoding/encoding using encode/decode function)
...
2999 | 299.9 km/h (decoding/encoding using encode/decode function)
3000 | 3000 (no decoding/encoding - as per RawDataRecord; potentially to be handled by TableDataRecord encoding/decoding and adding labels as physical values like Fault, Init)
3001 | 3001 (no decoding/encoding - as per RawDataRecord; potentially to be handled by TableDataRecord encoding/decoding and adding labels as physical values like Fault, Init)
...
In other words we need:
- range where (endocidng/decoding) formulas are applied
- option to mix it with other
DataRecordsoutside the formula range
| raw_value = super().decode(raw_value) | ||
| return self._decode_function(raw_value) | ||
|
|
||
| def encode(self, physical_value: float) -> int: |
There was a problem hiding this comment.
same remark as per decode
|
|
||
| def decode(self, raw_value: int) -> DecodedDataRecord: | ||
| decoded_data_record: DecodedDataRecord = super().decode(raw_value) | ||
| physical_value = (decoded_data_record.raw_value / self._factor) + self._offset |
There was a problem hiding this comment.
I think it would be easier to just create encode_formula and decode_formula in init using factor and offset. Then you can inherit everything after CustomFormulaDataRecord cause all the rest would be the same.
Something like that (simplified):
class LinearFormulaDataRecord(CustomFormulaDataRecord):
def __init__(..., factor, offset, ...):
super(..., encode_fomula=lambda x: (x-offset)/factor, decode_formula=lambda x: x*factor + offset, ...
| ) | ||
| self.decode_formula = decode_formula | ||
| self.encode_formula = encode_formula | ||
| self.formula_range = formula_range |
There was a problem hiding this comment.
if formula_range argument is None, then we should set full range (0, (1<<length)-1) here..
| """ | ||
| Encode raw value for provided physical value. | ||
|
|
||
| :param physical_value: Physical (meaningful e.g. float, str type) value of this Data Record. | ||
|
|
||
| :return: Raw Value of this Data Record. | ||
| """ | ||
| if not isinstance(physical_value, int): | ||
| # TODO: after changing typing for physical_value this method need to be adjusted |
There was a problem hiding this comment.
Why do we need change here? I thought this part is already good.
| @@ -102,17 +102,19 @@ def decode(self, raw_value: int) -> DecodedDataRecord: | |||
| ) | |||
| return DecodedDataRecord(name=self.name, raw_value=raw_value, physical_value=raw_value) | |||
|
|
|||
| def encode(self, physical_value: DataRecordPhysicalValueAlias) -> int: | |||
| def encode(self, physical_value: DataRecordPhysicalValueAlias) -> DataRecordPhysicalValueAlias: | |||
There was a problem hiding this comment.
Why do we want to change output?
Description
Proposition for FormulaDataRecord