ParameterExploration.h

Go to the documentation of this file.

#ifndef SIMPT_PAREX_PARAMETER_EXPLORATION_H_
#define SIMPT_PAREX_PARAMETER_EXPLORATION_H_
/*
 * 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 "Exploration.h"

#include <utility>

namespace SimPT_Parex {

class ISweep;

class ParameterExploration : public Exploration
{
public:
        ParameterExploration(const std::string& name, const boost::property_tree::ptree& original,
                const boost::property_tree::ptree& preferences);

        ParameterExploration(const boost::property_tree::ptree& pt);

        ParameterExploration(const ParameterExploration& other);

        ParameterExploration& operator=(const ParameterExploration &other);

        virtual ~ParameterExploration();

        virtual ParameterExploration* Clone() const;

        virtual std::vector<std::string> GetParameters() const;

        virtual std::vector<std::string> GetValues(unsigned int index) const;

        virtual unsigned int GetNumberOfTasks() const;

        virtual SimTask* CreateTask(unsigned int index) const;

        virtual std::vector<std::string> GetPossibleParameters() const;

        std::string GetOriginalValue(const std::string& parameter) const;

        const ISweep* GetSweep(const std::string& parameter) const;

        const std::list<std::pair<std::string, ISweep*>>& GetSweeps() const { return m_sweeps; }

        void SetSweep(const std::string& parameter, ISweep* sweep);

        void RemoveSweep(const std::string& parameter);


        virtual boost::property_tree::ptree ToPtree() const;

private:
        virtual void ReadPtree(const boost::property_tree::ptree& pt);

private:
        boost::property_tree::ptree                  m_original;
        std::list<std::pair<std::string, ISweep*>>   m_sweeps;
};

} // namespace

#endif // end-of-include-guard