Skip to content

Typed Models

models

Pydantic models for typed SHM resources.

Classes

ShmEntityName

Bases: str, Enum

Supported SHM entity names.

ShmBaseModel

Bases: BaseModel

Base Pydantic configuration for SHM models.

ShmResourceRecord

Bases: ShmBaseModel

Base resource model shared by SHM entity records.

ShmQuery

Bases: BaseModel

Validated wrapper for backend filter payloads.

Functions
to_backend_filters
to_backend_filters()

Return backend-compatible filter arguments.

Source code in src/owi/metadatabase/shm/models.py
def to_backend_filters(self) -> dict[str, Any]:
    """Return backend-compatible filter arguments."""
    return dict(self.backend_filters)

SensorTypeRecord

Bases: ShmResourceRecord

Typed SHM sensor-type record.

SensorRecord

Bases: ShmResourceRecord

Typed SHM sensor record.

SensorCalibrationRecord

Bases: ShmResourceRecord

Typed SHM sensor calibration record.

SignalRecord

Bases: ShmResourceRecord

Typed SHM signal record.

SignalHistoryRecord

Bases: ShmResourceRecord

Typed SHM signal history record.

SignalCalibrationRecord

Bases: ShmResourceRecord

Typed SHM signal calibration record.

DerivedSignalRecord

Bases: ShmResourceRecord

Typed SHM derived-signal record.

DerivedSignalHistoryRecord

Bases: ShmResourceRecord

Typed SHM derived-signal history record.

DerivedSignalCalibrationRecord

Bases: ShmResourceRecord

Typed SHM derived-signal calibration record.