Skip to content

gds_control.dsl.model

ControlModel -- declarative container for control system specifications.

Bases: BaseModel

A complete state-space control system declaration.

Validates at construction: 1. At least one state 2. No duplicate names across all elements 3. Sensor observes references declared state names 4. Controller reads references declared sensor/input names 5. Controller drives references declared state names

Source code in packages/gds-control/gds_control/dsl/model.py 
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
class ControlModel(BaseModel):
    """A complete state-space control system declaration.

    Validates at construction:
    1. At least one state
    2. No duplicate names across all elements
    3. Sensor observes references declared state names
    4. Controller reads references declared sensor/input names
    5. Controller drives references declared state names
    """

    name: str
    states: list[State]
    inputs: list[Input] = Field(default_factory=list)
    sensors: list[Sensor] = Field(default_factory=list)
    controllers: list[Controller] = Field(default_factory=list)
    description: str = ""

    @model_validator(mode="after")
    def _validate_structure(self) -> Self:
        errors: list[str] = []

        # 1. At least one state
        if not self.states:
            errors.append("Model must have at least one state")

        # 2. No duplicate names
        all_names: list[str] = []
        for s in self.states:
            all_names.append(s.name)
        for i in self.inputs:
            all_names.append(i.name)
        for s in self.sensors:
            all_names.append(s.name)
        for c in self.controllers:
            all_names.append(c.name)

        seen: set[str] = set()
        for n in all_names:
            if n in seen:
                errors.append(f"Duplicate element name: {n!r}")
            seen.add(n)

        state_names = {s.name for s in self.states}
        sensor_names = {s.name for s in self.sensors}
        input_names = {i.name for i in self.inputs}
        readable_names = sensor_names | input_names

        # 3. Sensor observes references declared state names
        for sensor in self.sensors:
            for obs in sensor.observes:
                if obs not in state_names:
                    errors.append(
                        f"Sensor {sensor.name!r} observes {obs!r} "
                        f"which is not a declared state"
                    )

        # 4. Controller reads references declared sensor/input names
        for ctrl in self.controllers:
            for read in ctrl.reads:
                if read not in readable_names:
                    errors.append(
                        f"Controller {ctrl.name!r} reads {read!r} "
                        f"which is not a declared sensor or input"
                    )

        # 5. Controller drives references declared state names
        for ctrl in self.controllers:
            for drive in ctrl.drives:
                if drive not in state_names:
                    errors.append(
                        f"Controller {ctrl.name!r} drives {drive!r} "
                        f"which is not a declared state"
                    )

        if errors:
            raise CSValidationError(
                f"ControlModel {self.name!r} validation failed:\n"
                + "\n".join(f"  - {e}" for e in errors)
            )
        return self

    # ── Convenience properties ──────────────────────────────

    @property
    def element_names(self) -> set[str]:
        """All element names in the model."""
        names: set[str] = set()
        for s in self.states:
            names.add(s.name)
        for i in self.inputs:
            names.add(i.name)
        for s in self.sensors:
            names.add(s.name)
        for c in self.controllers:
            names.add(c.name)
        return names

    @property
    def state_names(self) -> set[str]:
        return {s.name for s in self.states}

    @property
    def sensor_names(self) -> set[str]:
        return {s.name for s in self.sensors}

    @property
    def input_names(self) -> set[str]:
        return {i.name for i in self.inputs}

    # ── Compilation ─────────────────────────────────────────

    def compile(self) -> GDSSpec:
        """Compile this model to a GDS specification."""
        from gds_control.dsl.compile import compile_model

        return compile_model(self)

    def compile_system(self) -> SystemIR:
        """Compile this model to a flat SystemIR for verification + visualization."""
        from gds_control.dsl.compile import compile_to_system

        return compile_to_system(self)

element_names property

All element names in the model.

compile()

Compile this model to a GDS specification.

Source code in packages/gds-control/gds_control/dsl/model.py 
133
134
135
136
137
def compile(self) -> GDSSpec:
    """Compile this model to a GDS specification."""
    from gds_control.dsl.compile import compile_model

    return compile_model(self)

compile_system()

Compile this model to a flat SystemIR for verification + visualization.

Source code in packages/gds-control/gds_control/dsl/model.py 
139
140
141
142
143
def compile_system(self) -> SystemIR:
    """Compile this model to a flat SystemIR for verification + visualization."""
    from gds_control.dsl.compile import compile_to_system

    return compile_to_system(self)