:py:mod:`vspyx.VehicleSpy`
==========================

.. py:module:: vspyx.VehicleSpy


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   vspyx.VehicleSpy.Database
   vspyx.VehicleSpy.DatabaseOpener
   vspyx.VehicleSpy.Module
   vspyx.VehicleSpy.Observer




.. py:class:: Database

   Bases: :py:obj:`vspyx.Core.ResolverObject`

   .. autoapi-inheritance-diagram:: vspyx.VehicleSpy.Database
      :parts: 1
      :private-bases:

   Database
           

   .. py:attribute:: OnConfigurationMutation
      :annotation: :vspyx.Core.Callback_634bd5c449

      

   .. py:attribute:: Topology
      :annotation: :vspyx.Communication.Topology

      

   .. py:method:: AddAutomaticMapping(self, channelURI: str, driverMatch: str) -> Any


   .. py:method:: ClearAutomaticMappings(self) -> Any


   .. py:method:: CloneConfiguration(self) -> Any

      Return the immutable configuration of this object.

      Except for the resolver parenting relationship, this represents the
      entire serializable state of the object.



   .. py:method:: Load(self) -> vspyx.Core.Task_a3295bec43


   .. py:method:: New(config: Any) -> Database
      :staticmethod:


   .. py:method:: RemoveAutomaticMapping(self, channelURI: str) -> Any


   .. py:method:: SetAutomaticMapping(self, channelURI: str, driverMatch: str) -> Any


   .. py:method:: UpdateAutomaticMappings(self) -> Any



.. py:class:: DatabaseOpener

   Bases: :py:obj:`vspyx.Core.ResolverObject`

   .. autoapi-inheritance-diagram:: vspyx.VehicleSpy.DatabaseOpener
      :parts: 1
      :private-bases:

   DatabaseOpener
           

   .. py:method:: CanOpen(self, path: str) -> bool


   .. py:method:: Open(self, path: str) -> vspyx.Core.Task_ca7052f7e4



.. py:class:: Module

   Bases: :py:obj:`vspyx.Core.Module`

   .. autoapi-inheritance-diagram:: vspyx.VehicleSpy.Module
      :parts: 1
      :private-bases:

   Module
           

   .. py:attribute:: AvailableSources
      :annotation: :vspyx.Core.ResolverOwningCollection

      

   .. py:attribute:: Databases
      :annotation: :vspyx.Core.ResolverOwningCollection

      

   .. py:attribute:: IsRunning
      :annotation: :bool

      

   .. py:attribute:: Objects
      :annotation: :vspyx.Core.ResolverOwningCollection

      

   .. py:attribute:: Observer
      :annotation: :Observer

      The Observer is an element in the Environment that we create and attach
      to every channel in the topology.

      Its purpose is to be all-seeing of network traffic in the
      application, and provide the Runtime::Environment that the
      MonitorView and other such views can watch.
              


   .. py:attribute:: OnAfterFileLoadOrClear
      :annotation: :vspyx.Core.Callback_6ee07abf48

      

   .. py:attribute:: OnAfterStartRunning
      :annotation: :vspyx.Core.Callback_2cfb0f7969

      

   .. py:attribute:: OnAfterStopRunning
      :annotation: :vspyx.Core.Callback_634bd5c449

      

   .. py:attribute:: OnBeforeFileLoadOrClear
      :annotation: :vspyx.Core.Callback_634bd5c449

      

   .. py:attribute:: OnBeforeStartRunning
      :annotation: :vspyx.Core.Callback_634bd5c449

      

   .. py:attribute:: OnBeforeStopRunning
      :annotation: :vspyx.Core.Callback_634bd5c449

      

   .. py:attribute:: Scheduler
      :annotation: :vspyx.Runtime.Scheduler

      

   .. py:method:: AddDatabase(self, path: str) -> Database


   .. py:method:: AddDatabaseOpener(self, opener: DatabaseOpener) -> Any


   .. py:method:: AddSource(self, description: str) -> vspyx.Communication.SourceHandle
               AddSource(self, instance: vspyx.Communication.SourceHandle) -> Any


   .. py:method:: CloneState(self) -> Any


   .. py:method:: New(self) -> Any


   .. py:method:: PrepareForStart(self) -> Observer
               PrepareForStart(self, analysisMode: bool) -> Observer
               PrepareForStart(self, analysisMode: bool, ticker: vspyx.Runtime.SchedulerTicker) -> Observer


   .. py:method:: RefreshAvailableSources(self) -> Any


   .. py:method:: RemoveSource(self, handle: vspyx.Communication.SourceHandle) -> Any


   .. py:method:: ReviewBuffer(self, path: str) -> vspyx.Core.ScheduledTask_ef25277eaf


   .. py:method:: SaveAs(self, path: str) -> Any


   .. py:method:: Start(self) -> Observer


   .. py:method:: Stop(self) -> Any


   .. py:method:: UpdateState(self, state: Any) -> Any



.. py:class:: Observer

   Bases: :py:obj:`vspyx.Communication.Architecture`

   .. autoapi-inheritance-diagram:: vspyx.VehicleSpy.Observer
      :parts: 1
      :private-bases:

   Observer
           

   .. py:method:: New() -> Observer
      :staticmethod: