Skip to content

gds_business.vsm.model

ValueStreamModel — declarative container for value stream maps.

Bases: BaseModel

A complete value stream map declaration.

Validates at construction: 1. At least one process step 2. No duplicate element names 3. Flow source/target reference declared elements 4. Buffer between references declared steps

Source code in packages/gds-business/gds_business/vsm/model.py 
 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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
class ValueStreamModel(BaseModel):
    """A complete value stream map declaration.

    Validates at construction:
    1. At least one process step
    2. No duplicate element names
    3. Flow source/target reference declared elements
    4. Buffer between references declared steps
    """

    name: str
    steps: list[ProcessStep]
    buffers: list[InventoryBuffer] = Field(default_factory=list)
    suppliers: list[Supplier] = Field(default_factory=list)
    customers: list[Customer] = Field(default_factory=list)
    material_flows: list[MaterialFlow] = Field(default_factory=list)
    information_flows: list[InformationFlow] = Field(default_factory=list)
    description: str = ""

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

        # 1. At least one process step
        if not self.steps:
            errors.append("VSM must have at least one process step")

        # 2. No duplicate element names
        all_names: list[str] = []
        for s in self.steps:
            all_names.append(s.name)
        for b in self.buffers:
            all_names.append(b.name)
        for s in self.suppliers:
            all_names.append(s.name)
        for c in self.customers:
            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)

        all_element_names = set(all_names)

        # 3. Flow source/target reference declared elements
        for flow in self.material_flows:
            if flow.source not in all_element_names:
                errors.append(
                    f"MaterialFlow source {flow.source!r} is not a declared element"
                )
            if flow.target not in all_element_names:
                errors.append(
                    f"MaterialFlow target {flow.target!r} is not a declared element"
                )

        for flow in self.information_flows:
            if flow.source not in all_element_names:
                errors.append(
                    f"InformationFlow source {flow.source!r} is not a declared element"
                )
            if flow.target not in all_element_names:
                errors.append(
                    f"InformationFlow target {flow.target!r} is not a declared element"
                )

        # 4. Buffer between references declared steps
        step_names = {s.name for s in self.steps}
        for buf in self.buffers:
            upstream, downstream = buf.between
            if upstream not in step_names:
                errors.append(
                    f"Buffer {buf.name!r} upstream step {upstream!r} "
                    f"is not a declared step"
                )
            if downstream not in step_names:
                errors.append(
                    f"Buffer {buf.name!r} downstream step {downstream!r} "
                    f"is not a declared step"
                )

        if errors:
            raise BizValidationError(
                f"ValueStreamModel {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]:
        names: set[str] = set()
        for s in self.steps:
            names.add(s.name)
        for b in self.buffers:
            names.add(b.name)
        for s in self.suppliers:
            names.add(s.name)
        for c in self.customers:
            names.add(c.name)
        return names

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

    @property
    def buffer_names(self) -> set[str]:
        return {b.name for b in self.buffers}

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

    @property
    def customer_names(self) -> set[str]:
        return {c.name for c in self.customers}

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

    def compile(self) -> GDSSpec:
        """Compile this model to a GDS specification."""
        from gds_business.vsm.compile import compile_vsm

        return compile_vsm(self)

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

        return compile_vsm_to_system(self)

compile()

Compile this model to a GDS specification.

Source code in packages/gds-business/gds_business/vsm/model.py 
151
152
153
154
155
def compile(self) -> GDSSpec:
    """Compile this model to a GDS specification."""
    from gds_business.vsm.compile import compile_vsm

    return compile_vsm(self)

compile_system()

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

Source code in packages/gds-business/gds_business/vsm/model.py 
157
158
159
160
161
def compile_system(self) -> SystemIR:
    """Compile this model to a flat SystemIR for verification + visualization."""
    from gds_business.vsm.compile import compile_vsm_to_system

    return compile_vsm_to_system(self)