ControlHelper.h

Go to the documentation of this file.

/*
 *  This 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
 *  any later version.
 *  The software 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 the software. If not, see <http://www.gnu.org/licenses/>.
 *
 *  Copyright 2017, 2018, Kuylen E, Willem L, Broeckhove J
 */

#pragma once

#include "util/RnMan.h"
#include "util/Stopwatch.h"

#include <boost/property_tree/ptree.hpp>
#include <memory>
#include <spdlog/spdlog.h>
#include <string>

namespace stride {

class SimRunner;

class ControlHelper
{
public:
        explicit ControlHelper(const boost::property_tree::ptree& config, std::string name);

        ~ControlHelper();

protected:
        explicit ControlHelper();

        void CheckEnv();

        // Output_prefix: if it's a string not containing any / it gets interpreted as a
        // filename prefix; otherwise we 'll create the corresponding directory.
        void CheckOutputPrefix();

        void InstallLogger();

        void LogStartup();

        void RegisterViewers(std::shared_ptr<SimRunner> runner);

        void Shutdown();

protected:
        boost::property_tree::ptree     m_config;           
        std::string                     m_name;             
        std::string                     m_output_prefix;    
        util::Stopwatch<>               m_run_clock;        
        std::shared_ptr<spdlog::logger> m_stride_logger;    
        bool                            m_use_install_dirs; 
};

} // namespace stride