Source code for event_model.documents.event

# ruff: noqa
# generated by datamodel-codegen:
#   filename:  event.json

from __future__ import annotations

from typing import Any, Dict, TypedDict, Union

from typing_extensions import NotRequired


class PartialEvent(TypedDict):
    data: Dict[str, Any]
    """
    The actual measurement data
    """
    filled: NotRequired[Dict[str, Union[bool, str]]]
    """
    Mapping each of the keys of externally-stored data to the boolean False, indicating that the data has not been loaded, or to foreign keys (moved here from 'data' when the data was loaded)
    """
    time: float
    """
    The event time. This maybe different than the timestamps on each of the data entries.
    """
    timestamps: Dict[str, Any]
    """
    The timestamps of the individual measurement data
    """




class Event(PartialEvent):
    """
    Document to record a quanta of collected data
    """

    descriptor: str
    """
    UID of the EventDescriptor to which this Event belongs
    """
    seq_num: int
    """
    Sequence number to identify the location of this Event in the Event stream
    """
    uid: str
    """
    Globally unique identifier for this Event
    """