Engine.hpp

Go to the documentation of this file.

/******************************************************************************
 * This file is part of project ORCA. More information on the project
 * can be found at the following repositories at GitHub's website.
 *
 * http://https://github.com/andersondomingues/orca-sim
 * http://https://github.com/andersondomingues/orca-software
 * http://https://github.com/andersondomingues/orca-mpsoc
 * http://https://github.com/andersondomingues/orca-tools
 *
 * Copyright (C) 2018-2020 Anderson Domingues, <ti.andersondomingues@gmail.com>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
******************************************************************************/
#ifndef ORCASIM_BASE_INCLUDE_ENGINE_HPP_
#define ORCASIM_BASE_INCLUDE_ENGINE_HPP_

// lib dependencies
#include <iostream>
#include <array>
#include <queue>
#include <string>

// own api dependencies
#include "Event.hpp"
#include "SimulationTime.hpp"

namespace orcasim::base {

class Engine{
 private:
    SimulationTime _epochs;

    std::priority_queue<Event> _queue;

    SimulationTime _globalTime;

    SimulationTime _timeout;

    void executeNext();

 public:
    Engine();

    /* run the simulation for <time> cycles. */
    SimulationTime Run(SimulationTime time = 100000);

    SimulationTime GetGlobalTime();

    SimulationTime GetEpochs();

    SimulationTime NextEpoch();

    void Schedule(const Event& e);

    ~Engine();
};

}  // namespace orcasim::base
#endif  // ORCASIM_BASE_INCLUDE_ENGINE_HPP_