nominal-api 0.604.0__py3-none-any.whl → 0.606.0__py3-none-any.whl

nominal_api/__init__.py

@@ -72,5 +72,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.604.0"
+__version__ = "0.606.0"
 

nominal_api/_impl.py

@@ -10687,7 +10687,8 @@ default, follow the UCUM convention for representation.
 
     def get_commensurable_units(self, auth_header: str, unit: str) -> List["scout_units_api_Unit"]:
         """
-        Returns the set of units that can be converted to and from the given unit.
+        Returns the set of cataloged units that can be converted to and from the given unit.
+No commensurable units does not imply the unit is invalid. Use /get-unit to check for validity.
         """
 
         _headers: Dict[str, Any] = {
@@ -16644,6 +16645,162 @@ scout_chartdefinition_api_AxisThresholdVisualization.__qualname__ = "AxisThresho
 scout_chartdefinition_api_AxisThresholdVisualization.__module__ = "nominal_api.scout_chartdefinition_api"
 
 
+class scout_chartdefinition_api_BitFlag(ConjureBeanType):
+    """
+    The settings for a bit flag mapping. Each position should be unique. Position 0 represents the least significant bit 
+and position 31 represents the most significant bit.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'position': ConjureFieldDefinition('position', int),
+            'label': ConjureFieldDefinition('label', str)
+        }
+
+    __slots__: List[str] = ['_position', '_label']
+
+    def __init__(self, label: str, position: int) -> None:
+        self._position = position
+        self._label = label
+
+    @builtins.property
+    def position(self) -> int:
+        return self._position
+
+    @builtins.property
+    def label(self) -> str:
+        return self._label
+
+
+scout_chartdefinition_api_BitFlag.__name__ = "BitFlag"
+scout_chartdefinition_api_BitFlag.__qualname__ = "BitFlag"
+scout_chartdefinition_api_BitFlag.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
+class scout_chartdefinition_api_BitFlagMapCellConfig(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'visualisation': ConjureFieldDefinition('visualisation', OptionalTypeWrapper[scout_chartdefinition_api_BitFlagMapVisualisation])
+        }
+
+    __slots__: List[str] = ['_visualisation']
+
+    def __init__(self, visualisation: Optional["scout_chartdefinition_api_BitFlagMapVisualisation"] = None) -> None:
+        self._visualisation = visualisation
+
+    @builtins.property
+    def visualisation(self) -> Optional["scout_chartdefinition_api_BitFlagMapVisualisation"]:
+        return self._visualisation
+
+
+scout_chartdefinition_api_BitFlagMapCellConfig.__name__ = "BitFlagMapCellConfig"
+scout_chartdefinition_api_BitFlagMapCellConfig.__qualname__ = "BitFlagMapCellConfig"
+scout_chartdefinition_api_BitFlagMapCellConfig.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
+class scout_chartdefinition_api_BitFlagMapRawVisualisation(ConjureBeanType):
+    """
+    The settings for a raw bit flag map visualisation.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'high_color': ConjureFieldDefinition('highColor', OptionalTypeWrapper[scout_api_HexColor]),
+            'low_color': ConjureFieldDefinition('lowColor', OptionalTypeWrapper[scout_api_HexColor]),
+            'bit_flags': ConjureFieldDefinition('bitFlags', List[scout_chartdefinition_api_BitFlag])
+        }
+
+    __slots__: List[str] = ['_high_color', '_low_color', '_bit_flags']
+
+    def __init__(self, bit_flags: List["scout_chartdefinition_api_BitFlag"], high_color: Optional[str] = None, low_color: Optional[str] = None) -> None:
+        self._high_color = high_color
+        self._low_color = low_color
+        self._bit_flags = bit_flags
+
+    @builtins.property
+    def high_color(self) -> Optional[str]:
+        """
+        The color when any bit is high
+        """
+        return self._high_color
+
+    @builtins.property
+    def low_color(self) -> Optional[str]:
+        """
+        The color when all bits are low
+        """
+        return self._low_color
+
+    @builtins.property
+    def bit_flags(self) -> List["scout_chartdefinition_api_BitFlag"]:
+        return self._bit_flags
+
+
+scout_chartdefinition_api_BitFlagMapRawVisualisation.__name__ = "BitFlagMapRawVisualisation"
+scout_chartdefinition_api_BitFlagMapRawVisualisation.__qualname__ = "BitFlagMapRawVisualisation"
+scout_chartdefinition_api_BitFlagMapRawVisualisation.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
+class scout_chartdefinition_api_BitFlagMapVisualisation(ConjureUnionType):
+    _raw: Optional["scout_chartdefinition_api_BitFlagMapRawVisualisation"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'raw': ConjureFieldDefinition('raw', scout_chartdefinition_api_BitFlagMapRawVisualisation)
+        }
+
+    def __init__(
+            self,
+            raw: Optional["scout_chartdefinition_api_BitFlagMapRawVisualisation"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (raw is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if raw is not None:
+                self._raw = raw
+                self._type = 'raw'
+
+        elif type_of_union == 'raw':
+            if raw is None:
+                raise ValueError('a union value must not be None')
+            self._raw = raw
+            self._type = 'raw'
+
+    @builtins.property
+    def raw(self) -> Optional["scout_chartdefinition_api_BitFlagMapRawVisualisation"]:
+        return self._raw
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_chartdefinition_api_BitFlagMapVisualisationVisitor):
+            raise ValueError('{} is not an instance of scout_chartdefinition_api_BitFlagMapVisualisationVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'raw' and self.raw is not None:
+            return visitor._raw(self.raw)
+
+
+scout_chartdefinition_api_BitFlagMapVisualisation.__name__ = "BitFlagMapVisualisation"
+scout_chartdefinition_api_BitFlagMapVisualisation.__qualname__ = "BitFlagMapVisualisation"
+scout_chartdefinition_api_BitFlagMapVisualisation.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
+class scout_chartdefinition_api_BitFlagMapVisualisationVisitor:
+
+    @abstractmethod
+    def _raw(self, raw: "scout_chartdefinition_api_BitFlagMapRawVisualisation") -> Any:
+        pass
+
+
+scout_chartdefinition_api_BitFlagMapVisualisationVisitor.__name__ = "BitFlagMapVisualisationVisitor"
+scout_chartdefinition_api_BitFlagMapVisualisationVisitor.__qualname__ = "BitFlagMapVisualisationVisitor"
+scout_chartdefinition_api_BitFlagMapVisualisationVisitor.__module__ = "nominal_api.scout_chartdefinition_api"
+
+
 class scout_chartdefinition_api_CartesianChartDefinition(ConjureUnionType):
     _v1: Optional["scout_chartdefinition_api_CartesianChartDefinitionV1"] = None
 
@@ -19412,13 +19569,15 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
     _numeric: Optional["scout_chartdefinition_api_NumericCellConfig"] = None
     _enum: Optional["scout_chartdefinition_api_EnumCellConfig"] = None
     _range: Optional["scout_chartdefinition_api_RangeCellConfig"] = None
+    _bit_flag_map: Optional["scout_chartdefinition_api_BitFlagMapCellConfig"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'numeric': ConjureFieldDefinition('numeric', scout_chartdefinition_api_NumericCellConfig),
             'enum': ConjureFieldDefinition('enum', scout_chartdefinition_api_EnumCellConfig),
-            'range': ConjureFieldDefinition('range', scout_chartdefinition_api_RangeCellConfig)
+            'range': ConjureFieldDefinition('range', scout_chartdefinition_api_RangeCellConfig),
+            'bit_flag_map': ConjureFieldDefinition('bitFlagMap', scout_chartdefinition_api_BitFlagMapCellConfig)
         }
 
     def __init__(
@@ -19426,10 +19585,11 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
             numeric: Optional["scout_chartdefinition_api_NumericCellConfig"] = None,
             enum: Optional["scout_chartdefinition_api_EnumCellConfig"] = None,
             range: Optional["scout_chartdefinition_api_RangeCellConfig"] = None,
+            bit_flag_map: Optional["scout_chartdefinition_api_BitFlagMapCellConfig"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (numeric is not None) + (enum is not None) + (range is not None) != 1:
+            if (numeric is not None) + (enum is not None) + (range is not None) + (bit_flag_map is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if numeric is not None:
@@ -19441,6 +19601,9 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
             if range is not None:
                 self._range = range
                 self._type = 'range'
+            if bit_flag_map is not None:
+                self._bit_flag_map = bit_flag_map
+                self._type = 'bitFlagMap'
 
         elif type_of_union == 'numeric':
             if numeric is None:
@@ -19457,6 +19620,11 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._range = range
             self._type = 'range'
+        elif type_of_union == 'bitFlagMap':
+            if bit_flag_map is None:
+                raise ValueError('a union value must not be None')
+            self._bit_flag_map = bit_flag_map
+            self._type = 'bitFlagMap'
 
     @builtins.property
     def numeric(self) -> Optional["scout_chartdefinition_api_NumericCellConfig"]:
@@ -19470,6 +19638,10 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
     def range(self) -> Optional["scout_chartdefinition_api_RangeCellConfig"]:
         return self._range
 
+    @builtins.property
+    def bit_flag_map(self) -> Optional["scout_chartdefinition_api_BitFlagMapCellConfig"]:
+        return self._bit_flag_map
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_chartdefinition_api_ValueTableCellConfigVisitor):
             raise ValueError('{} is not an instance of scout_chartdefinition_api_ValueTableCellConfigVisitor'.format(visitor.__class__.__name__))
@@ -19479,6 +19651,8 @@ class scout_chartdefinition_api_ValueTableCellConfig(ConjureUnionType):
             return visitor._enum(self.enum)
         if self._type == 'range' and self.range is not None:
             return visitor._range(self.range)
+        if self._type == 'bitFlagMap' and self.bit_flag_map is not None:
+            return visitor._bit_flag_map(self.bit_flag_map)
 
 
 scout_chartdefinition_api_ValueTableCellConfig.__name__ = "ValueTableCellConfig"
@@ -19500,6 +19674,10 @@ class scout_chartdefinition_api_ValueTableCellConfigVisitor:
     def _range(self, range: "scout_chartdefinition_api_RangeCellConfig") -> Any:
         pass
 
+    @abstractmethod
+    def _bit_flag_map(self, bit_flag_map: "scout_chartdefinition_api_BitFlagMapCellConfig") -> Any:
+        pass
+
 
 scout_chartdefinition_api_ValueTableCellConfigVisitor.__name__ = "ValueTableCellConfigVisitor"
 scout_chartdefinition_api_ValueTableCellConfigVisitor.__qualname__ = "ValueTableCellConfigVisitor"

nominal_api/scout_chartdefinition_api/__init__.py

@@ -9,6 +9,11 @@ from .._impl import (
     scout_chartdefinition_api_AxisThresholdGroup as AxisThresholdGroup,
     scout_chartdefinition_api_AxisThresholdGroupVisitor as AxisThresholdGroupVisitor,
     scout_chartdefinition_api_AxisThresholdVisualization as AxisThresholdVisualization,
+    scout_chartdefinition_api_BitFlag as BitFlag,
+    scout_chartdefinition_api_BitFlagMapCellConfig as BitFlagMapCellConfig,
+    scout_chartdefinition_api_BitFlagMapRawVisualisation as BitFlagMapRawVisualisation,
+    scout_chartdefinition_api_BitFlagMapVisualisation as BitFlagMapVisualisation,
+    scout_chartdefinition_api_BitFlagMapVisualisationVisitor as BitFlagMapVisualisationVisitor,
     scout_chartdefinition_api_CartesianChartDefinition as CartesianChartDefinition,
     scout_chartdefinition_api_CartesianChartDefinitionV1 as CartesianChartDefinitionV1,
     scout_chartdefinition_api_CartesianChartDefinitionVisitor as CartesianChartDefinitionVisitor,

{nominal_api-0.604.0.dist-info → nominal_api-0.606.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.604.0
+Version: 0.606.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<3,>=2.8.0

{nominal_api-0.604.0.dist-info → nominal_api-0.606.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=hTHVwlYqjy2_YXJuCVtcZMebJOFhUufprY5ghtgRgDE,1902
-nominal_api/_impl.py,sha256=E4ZRcDzOwu91jjLO47Xtebob7QPE4LzhDDr5ZJlZnNs,2842099
+nominal_api/__init__.py,sha256=THYO1Cp3iERbar42sNhf0Xf2sNVb9JzTBed2Z_BnsIY,1902
+nominal_api/_impl.py,sha256=G3E8i2j0S-Mtn2LFzLM9l8-xFTH9IEH3eaV49cxNtgY,2849261
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=kJBEE_HLVpKYdLH12KyO-cSAVzwxYpBwaaDutCtT-LM,1236
 nominal_api/api_rids/__init__.py,sha256=qerno2fgGWLfokoSdCarKSXg2jDjTJpz45Wv8PnqI6Q,500
@@ -22,7 +22,7 @@ nominal_api/scout_assets/__init__.py,sha256=dT-b9HnbwVbI-fEalfskKSMGzhGRwZDZ2cdz
 nominal_api/scout_catalog/__init__.py,sha256=ZGm4w1YKd4B-3CNxijTpB-1B653nctA_R0u24oPS3To,3508
 nominal_api/scout_channelvariables_api/__init__.py,sha256=4OQV1O-M2MQE36yCGlyYftnqaXSddYTYTyGce_WC4JQ,466
 nominal_api/scout_chart_api/__init__.py,sha256=sw7WSYs6SarSW7x-3IBkSIrVea1cVFnQnpYiNKbCWnQ,184
-nominal_api/scout_chartdefinition_api/__init__.py,sha256=agFq9gd3BjT2Mvi1jMDii8hiMZaWx471uNk5vuqMiww,9094
+nominal_api/scout_chartdefinition_api/__init__.py,sha256=pXGFjL1eYAJXOxYXzRF6FvI6-uwRcscbF52uR1UqG_A,9486
 nominal_api/scout_checklistexecution_api/__init__.py,sha256=lpBtfyRP-ReEwNzFTcynDgiMe8ahtEJb75pg7cKl-Q0,3266
 nominal_api/scout_checks_api/__init__.py,sha256=RJH7HsXjUhItC11V9C-hfv6lkIfiSXyxnB8slUpaT2g,5203
 nominal_api/scout_comparisonnotebook_api/__init__.py,sha256=8BL5jE9NDxqCj9DyvZWSPhq6zw2J7xp6aLsl3x9rpyw,4530
@@ -69,7 +69,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Q9iZHurmyDsJIFbUg-Eb
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.604.0.dist-info/METADATA,sha256=lkrRil5k91i5VupYCupYeJWESSSMrC3QVkNtSZqTZT0,199
-nominal_api-0.604.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-nominal_api-0.604.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.604.0.dist-info/RECORD,,
+nominal_api-0.606.0.dist-info/METADATA,sha256=NJY6eBzaaZnUoKGvPba1Nt-blNlDYYejLN9MLMsVJu4,199
+nominal_api-0.606.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+nominal_api-0.606.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.606.0.dist-info/RECORD,,