Vamos Automotive Simulator git

//  Timing_Info.h - timing information and running order for all cars.
//
//  Copyright (C) 2001--2012 Sam Varner
//
//  This file is part of Vamos Automotive Simulator.
//
//  Vamos is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//  
//  Vamos is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//  
//  You should have received a copy of the GNU General Public License
//  along with Vamos.  If not, see <http://www.gnu.org/licenses/>.

#ifndef _TIMING_INFO_H_
#define _TIMING_INFO_H_

#include <cstddef>
#include <vector>
#include <list>

namespace Vamos_World
{
  /// Lap times, sector times, running order, and intervals.
  class Timing_Info
  {
    enum Timing_State
      {
        STARTING, ///< The session has not yet begin.
        RUNNING,  ///< The session has started.
        FINISHED  ///< The session is over, but some cars may be on track.
      };

  public:
    class Car_Timing;
    typedef std::list <const Car_Timing*> Running_Order;

    /// Initialize the timing information.
    /// @param n_cars The number of cars added to the world.
    /// @param n_sectors The number of timing sectors per lap. Must be > 0. 
    /// @param do_start_sequence If true, do the countdown to the start of the
    ///                          session. Otherwise start immediately. 
    Timing_Info (size_t n_cars, size_t n_sectors, bool do_start_sequence);
    ~Timing_Info ();

    void set_time_limit (double minutes) { m_time_limit = 60.0 * minutes; }
    void set_lap_limit (size_t laps) { m_lap_limit = laps; }
    void set_qualifying () { m_qualifying = true; }

    bool qualifying () const { return m_qualifying; }

    /// Return the number of counts until the start of the session. Intervals
    /// are seconds except for 1 to 0 which has an extra random delay. The race
    /// starts when the count reaches 0 and stays that way through the session.
    int countdown () const { return m_countdown; }

    /// Return the total number of laps specified at construction. May be
    /// zero. Fixed. 
    size_t total_laps () const { return m_lap_limit; }
    /// Return the time since the start of the session. Updated continuously.
    double total_time () const { return m_total_time; }
    /// Reset the global timer and the cars' times.
    void reset ();
    /// Update the total time and the timing for the car with the specified index.
    void update (double current_time, size_t index, double distance, size_t sector);

    double time_remaining () const;

    bool is_finished () const { return m_state == FINISHED; } 

    const Running_Order& running_order () const { return ma_running_order; }

    const Car_Timing& timing_at_index (size_t index) const 
    { return *ma_car_timing [index]; }

    const Car_Timing* fastest_lap_timing () const { return mp_fastest; }

    static const double NO_TIME; 

    class Car_Timing
    {
      friend class Timing_Info;

    public:
      Car_Timing (size_t position, size_t sectors);

      void reset ();

      /// The (incomplete) lap the car is currently on. It's 0 before the start
      /// of the session, 1 as soon as the timer starts. Updated each lap.
      size_t current_lap () const { return m_lap; }
      /// Return the number of completed laps.
      size_t laps_complete () const { return (m_lap == 0) ? 0 : m_lap - 1; }
      /// The car's position at the start. Fixed.
      size_t grid_position () const { return m_grid_position; }
      /// Return the time interval to the car ahead. -1 is returned for the
      /// leader, all other intervals are non-negative. Updated each time a car
      /// completes a sector.
      double interval () const { return m_interval; }

      /// The distance traveled on the current lap. Resets to zero each lap at the
      /// finish line. May be > 0 at the start of the session. Updated
      /// continuously. 
      double lap_distance () const { return m_distance; }

      /// Time spent on the current lap so far. Updated continuously.
      double lap_time () const;
      /// Time taken to complete the previous lap. Updated each lap.
      double previous_lap_time () const;
      /// The shortest previous lap time so far. Updated each lap.
      double best_lap_time () const { return m_best_lap_time; }
      /// (previous lap time) - (best lap time). Calculated before best lap time
      /// is updated. Updated each lap.
      double lap_time_difference () const { return m_lap_delta; }

      /// The (incomplete) sector the car is currently on. It's 0 before the start
      /// of the session. It's 1 as soon as the timer starts. Updated each time a
      /// car completes a sector.
      size_t current_sector () const { return m_sector; }
      /// The number of the last sector left. 0 until the 1st sector is
      /// complete. Updated each time a car completes a sector.
      size_t previous_sector () const { return m_last_sector; }
      /// Time spent in the current sector so far. Updated continuously.
      double sector_time () const;
      /// The shortest time on the current sector so far. Updated each sector.
      double best_sector_time () const;
      /// Time taken to complete the previous sector. Updated each sector.
      double previous_sector_time () const;
      /// (previous sector time) - (best previous sector time). Calculated before
      /// best sector time is updated. Updated each sector.
      double previous_sector_time_difference () const;

      bool is_finished () const { return m_finished; }

    private:
      void set_finished () { m_finished = true; }
      void update (double current_time, double distance, size_t sector, bool new_sector);
      bool is_start_of_lap (size_t sector) const;
      void update_lap_data (double current_time);
      void update_sector_data (double current_time, size_t sector);

      double m_grid_position;
      double m_current_time;
      double m_distance;
      double m_interval;
      size_t m_sectors;
      size_t m_sector;
      size_t m_last_sector;
      size_t m_lap;
      std::vector <double> ma_lap_time;
      double m_best_lap_time;
      std::vector <double> ma_best_sector_time;
      double m_lap_delta;
      std::vector <double> ma_sector_delta;
      std::vector <double> ma_sector_time;
      bool m_finished;
    };

  private:
    void next_state (double current_time);
    bool is_new_sector (size_t index, size_t sector) const;
    void update_position (Car_Timing* p_car, 
                          double current_time,
                          size_t sector,
                          bool finished);

    size_t m_sectors;
    size_t m_lap_limit;
    double m_time_limit;
    bool m_qualifying;
    int m_countdown;
    /// The random delay after the last light has been on for a second and
    /// before they all go out to signal the start of the race.
    double m_start_delay;
    Timing_State m_state;
    double m_total_time;
    /// How long the timer has been in the current state.
    double m_state_time;

    std::vector <Car_Timing*> ma_car_timing;
    std::vector <size_t> ma_sector_position;
    std::vector <double> ma_sector_time;
    Running_Order ma_running_order;
    Car_Timing* mp_fastest;
    double m_fastest_lap;
  };
}

#endif // not _TIMING_INFO_H_