epicsarchiver.retrieval.archive_event
=====================================

.. py:module:: epicsarchiver.retrieval.archive_event

.. autoapi-nested-parse::

   Archive Event module for the ArchiveEvent class.



Attributes
----------

.. autoapisummary::

   epicsarchiver.retrieval.archive_event.ArchiveEventsData


Classes
-------

.. autoapisummary::

   epicsarchiver.retrieval.archive_event.FieldValue
   epicsarchiver.retrieval.archive_event.ArchiveEventsMeta
   epicsarchiver.retrieval.archive_event.ArchiveEvent


Module Contents
---------------

.. py:class:: FieldValue

   Basic representation of a changed field value from an archive event.

   :returns: Pair of name and value
   :rtype: FieldValue


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: value
      :type:  str


.. py:class:: ArchiveEventsMeta

   Metadata about a year's chunk of archived events.


   .. py:attribute:: pv_name
      :type:  str


   .. py:attribute:: pv_type
      :type:  str


   .. py:attribute:: element_count
      :type:  int


   .. py:attribute:: headers
      :type:  list[FieldValue]


   .. py:attribute:: year
      :type:  int


.. py:data:: ArchiveEventsData

.. py:class:: ArchiveEvent

   One Event, retrieved from the AA, representing a change in value of a PV.


   .. py:attribute:: pv
      :type:  str


   .. py:attribute:: val
      :type:  int | float | str | list[str] | list[int] | list[float] | bytes


   .. py:attribute:: secondsintoyear
      :type:  int


   .. py:attribute:: year
      :type:  int


   .. py:attribute:: nanos
      :type:  int


   .. py:attribute:: severity
      :type:  int


   .. py:attribute:: status
      :type:  int


   .. py:attribute:: field_values
      :type:  list[FieldValue] | None


   .. py:property:: timestamp_ns
      :type: int


      Nanoseconds since Unix epoch.

      :returns: nanoseconds since Unix epoch, compatible with pl.Datetime("ns", "UTC")
      :rtype: int


   .. py:property:: timestamp
      :type: datetime.datetime


      UTC datetime (microsecond precision), derived from timestamp_ns.

      :returns: UTC datetime
      :rtype: datetime.datetime


   .. py:property:: field_values_dict
      :type: dict[str, str]


      Provides a dict of field values.

      :returns: dict of field names and values
      :rtype: dict[str, str]