add arrayName, type, numComponents to variable state

Author: LKasianAnsys

src/ansys/visor/viewer/models/common/visor_variable_state.py

@@ -2,7 +2,9 @@
 
 from typing import List, Tuple
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
+
+from ansys.visor.viewer.core.visor_enums import VisorVtkVariableType
 
 
 class VisorVariableState(BaseModel):
@@ -15,11 +17,24 @@ class VisorVariableState(BaseModel):
     a unique identifier for the variable: the variable name, type (POINT/CELL), and number of components, and computes
     the ranges across all datasets/parts that contain that variable.
 
+    ``array_name``, ``type`` and ``num_components`` are those same three identifying properties, carried
+    explicitly (rather than only opaquely inside ``id``) so a consumer can act on them without parsing the
+    client-built identifier.  They are required: a variable state with no known source array, association, or
+    component count is not a state this model can represent.
+
     In the future, the backend can own this, but for now we can treat this as passthrough data,
     as the id value is stable across sessions.
     """
     model_config = ConfigDict(populate_by_name=True)
 
     id: str = Field(...)
+    array_name: str = Field(..., alias="arrayName")
+    type: VisorVtkVariableType = Field(...)
+    num_components: int = Field(..., alias="numComponents")
     magnitude_range: Tuple[float, float] | None = Field(default=None, alias="magnitudeRange")
     ranges: List[Tuple[float, float]] = Field(default_factory=list)
+
+    @field_serializer("type")
+    def _serialize_type(self, value: VisorVtkVariableType) -> str:
+        """Emit the wire value (e.g. "POINT"/"CELL") for both dict-mode and JSON-mode dumps."""
+        return value.value

src/ansys/visor/viewer/models/persist/persisted_viewer_state.py

@@ -25,7 +25,7 @@ class PersistedViewerStateV1(BaseModel):
     """
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
-    version: Literal["1.0"] = Field(default="1.0")
+    version: Literal["1.1"] = Field(default="1.1")
 
     ui: VisorUIState = Field(default_factory=VisorUIState)
     scene: PersistedSceneState = Field(default_factory=PersistedSceneState)

src/ansys/visor/visor-client/src/VisorFrontend.tsx

@@ -260,6 +260,9 @@ export class VisorFrontend {
             for (const spectrumInfo of spectrumInfos.array) {
                 const spectrumState = new VisorSpectrumState();
                 spectrumState.setId(spectrumInfo.id.toString());
+                spectrumState.setArrayName(spectrumInfo.name);
+                spectrumState.setType(spectrumInfo.type);
+                spectrumState.setNumComponents(spectrumInfo.numComponents);
                 const magnitudeRange = spectrumInfo.getRangeInfo(-1);
                 if (magnitudeRange == null) {
                     throw new Error(`range at component ${-1} not found`);

src/ansys/visor/visor-client/src/state/appstate/VisorSpectrumState.tsx

@@ -1,13 +1,19 @@
 import {
     ensureArray,
     ensureNumberArray,
+    ensureNumber,
+    ensureString,
     JsonDict,
     parseState,
     StateInput,
 } from './VisorStateCommon.tsx';
+import type { FieldAssociation } from './vtkInfo/VisorVtkDataArray.tsx';
 
 export default class VisorSpectrumState {
     private _id: string = '';
+    private _arrayName: string = '';
+    private _type: FieldAssociation | undefined = undefined;
+    private _numComponents: number = 0;
     private _magnitudeRange: number[] | undefined = undefined;
     private _ranges: (number[] | undefined)[] = [];
 
@@ -28,6 +34,36 @@ export default class VisorSpectrumState {
         }
     }
 
+    get arrayName(): string {
+        return this._arrayName;
+    }
+
+    setArrayName(val: string | null | undefined): void {
+        if (val != null) {
+            this._arrayName = ensureString(val, 'val');
+        }
+    }
+
+    get type(): FieldAssociation | undefined {
+        return this._type;
+    }
+
+    setType(val: FieldAssociation | null | undefined): void {
+        if (val != null) {
+            this._type = val;
+        }
+    }
+
+    get numComponents(): number {
+        return this._numComponents;
+    }
+
+    setNumComponents(val: number | null | undefined): void {
+        if (val != null) {
+            this._numComponents = ensureNumber(val, 'val');
+        }
+    }
+
     get magnitudeRange(): number[] | undefined {
         return this._magnitudeRange;
     }
@@ -83,6 +119,11 @@ export default class VisorSpectrumState {
             }
 
             this.setId(thisId);
+            this.setArrayName(data.arrayName === undefined ? this._arrayName : data.arrayName);
+            this.setType(data.type === undefined ? this._type : data.type);
+            this.setNumComponents(
+                data.numComponents === undefined ? this._numComponents : data.numComponents
+            );
             this.setMagnitudeRange(
                 data.magnitudeRange === undefined ? this._magnitudeRange : data.magnitudeRange,
                 replace
@@ -99,6 +140,9 @@ export default class VisorSpectrumState {
     toDict(): JsonDict {
         return {
             id: this.id,
+            arrayName: this.arrayName,
+            type: this.type,
+            numComponents: this.numComponents,
             magnitudeRange: this.magnitudeRange,
             ranges: this.ranges,
         };

tests/unit/models/test_visor_variable_state.py

@@ -0,0 +1,26 @@
+"""Unit tests for VisorVariableState."""
+
+import pytest
+from pydantic import ValidationError
+
+from ansys.visor.viewer.core.visor_enums import VisorVtkVariableType
+from ansys.visor.viewer.models.common.visor_variable_state import VisorVariableState
+
+_VALID_KWARGS = {
+    "id": "POINT::displacement::3",
+    "array_name": "displacement",
+    "type": VisorVtkVariableType.POINT,
+    "num_components": 3,
+}
+
+
+@pytest.mark.parametrize("missing_field", ["array_name", "type", "num_components"])
+def test_construction_missing_required_field_raises(missing_field):
+    """Omitting any one of array_name, type, or num_components must raise,
+    proving each is required on its own rather than all three being
+    collectively-but-not-individually required."""
+    kwargs = {k: v for k, v in _VALID_KWARGS.items() if k != missing_field}
+
+    with pytest.raises(ValidationError):
+        VisorVariableState(**kwargs)
+