SimInterface.h

Go to the documentation of this file.

#ifndef SIM_SIMULATOR_INTERFACE_H_INCLUDED
#define SIM_SIMULATOR_INTERFACE_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 "sim/SimPhase.h"
#include "util/clock_man/Timeable.h"

#include <boost/property_tree/ptree_fwd.hpp>
#include <string>


namespace SimPT_Sim {

struct CoreData;

class SimInterface : public SimPT_Sim::ClockMan::Timeable<>
{
public:
        virtual ~SimInterface() {}

        virtual CoreData& GetCoreData() =0;

        virtual const boost::property_tree::ptree& GetParameters() const = 0;

        virtual std::string GetProjectName() const = 0;

        virtual std::string GetRunDate() const = 0;

        virtual int GetSimStep() const = 0;

        virtual Timings GetTimings() const = 0;

        virtual bool IsAtTermination() const = 0;

        virtual bool IsStationary() const = 0;

        virtual void Reinitialize(const boost::property_tree::ptree& parameters) = 0;

        virtual void TimeStep() = 0;
};

} // namespace

#endif // end_of_include_guard