:py:mod:`starling_sim.basemodel.agent.vehicles.vehicle`
=======================================================

.. py:module:: starling_sim.basemodel.agent.vehicles.vehicle


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

Classes
~~~~~~~

.. autoapisummary::

   starling_sim.basemodel.agent.vehicles.vehicle.Vehicle




.. py:class:: Vehicle(simulation_model, agent_id, origin, seats, **kwargs)


   Bases: :py:obj:`starling_sim.basemodel.agent.moving_agent.MovingAgent`

   This class describes the basic features of a vehicle agent

   It should be extended to implement more specific features and behaviours

   .. py:attribute:: SCHEMA

      

   .. py:method:: __str__()

      Give a string display to the simulation element


   .. py:method:: change_position(new_position, mode)

      The vehicle changes the position of all of its occupants along with its own.

      :param new_position:
      :param mode:
      :return:


   .. py:method:: trace_event(event)

      The vehicle adds its move and route traces to its occupants.

      :param event:
      :return:


   .. py:method:: load()

      Compute the current load of the vehicle.

      :return: vehicle load


   .. py:method:: add_passenger(passenger)


   .. py:method:: get_passenger(passenger)

      Add the passenger to the list of occupants.

      :param passenger: agent


   .. py:method:: remove_passenger(passenger)


   .. py:method:: leave_passenger(passenger)

      Remove the passenger from the list of occupants.

      :param passenger: agent