TimeSlicer.h

Go to the documentation of this file.

#ifndef SIM_STEP_CONTROLLER_H_INCLUDED
#define SIM_STEP_CONTROLLER_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include "SimPhase.h"

#include <mutex>

namespace SimPT_Sim {

class Sim;

class TimeSlicer
{
public:
        TimeSlicer(std::mutex& time_step_mutex, Sim* sim);

        TimeSlicer(const TimeSlicer& other) =delete;

        TimeSlicer& operator=(const TimeSlicer& other) =delete;

        ~TimeSlicer();

        void IncrementStepCount();

        void Go(double time_slice, SimPhase phase = SimPhase::NONE);

private:
        std::lock_guard<std::mutex>    m_guard;            
        Sim*                           m_sim;              
};

} // namespace

#endif // end_of_include_guard