SimWrapper.h

Go to the documentation of this file.

#ifndef SIMWRAPPER_H_INCLUDED
#define SIMWRAPPER_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 <string>
#include <memory>

namespace SimPT_Sim {

class Sim;
class SimState;

enum SimWrapperStatus { SUCCESS, FAILURE };

template <typename T>
struct SimWrapperResult {
        SimWrapperStatus  status;
        std::string       message;
        T                 value;
};

template<>
struct SimWrapperResult<void> {
        SimWrapperStatus  status;
        std::string     message;
};


class SimWrapper {
public:
        SimWrapper();

        SimWrapperResult<SimState> GetState() const;

        SimWrapperResult<std::string> GetXMLState() const;

        SimWrapperResult<void> Initialize(SimState state);

        SimWrapperResult<void> Initialize(const std::string& path);

        SimWrapperResult<void> TimeStep();

private:
        std::shared_ptr<Sim> m_sim;
};

} // namespace

#endif // include guard