vikit.common.models
===================

.. py:module:: vikit.common.models


Overview
--------

.. list-table:: Classes
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`TimePeriod <vikit.common.models.TimePeriod>`
     - A generic DTO to represent a time period, e.g in a video.




Classes
-------

.. py:class:: TimePeriod(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`

   A generic DTO to represent a time period, e.g in a video.


   .. rubric:: Overview

   .. list-table:: Attributes
      :header-rows: 0
      :widths: auto
      :class: summarytable

      * - :py:obj:`end_time_sec <vikit.common.models.TimePeriod.end_time_sec>`
        - \-
      * - :py:obj:`start_time_sec <vikit.common.models.TimePeriod.start_time_sec>`
        - \-


   .. list-table:: Methods
      :header-rows: 0
      :widths: auto
      :class: summarytable

      * - :py:obj:`verify_end_time_sec <vikit.common.models.TimePeriod.verify_end_time_sec>`\ ()
        - \-


   .. rubric:: Members

   .. py:attribute:: end_time_sec
      :type:  typing_extensions.Annotated[float, seconds]

   .. py:attribute:: start_time_sec
      :type:  typing_extensions.Annotated[float, Ge(0.0), seconds]

   .. py:method:: verify_end_time_sec()