VPTissue Reference Manual
FileExploration.h
Go to the documentation of this file.
1 #ifndef SIMPT_PAREX_FILE_EXPLORATION_H_
2 #define SIMPT_PAREX_FILE_EXPLORATION_H_
3 /*
4  * Copyright 2011-2016 Universiteit Antwerpen
5  *
6  * Licensed under the EUPL, Version 1.1 or as soon they will be approved by
7  * the European Commission - subsequent versions of the EUPL (the "Licence");
8  * You may not use this work except in compliance with the Licence.
9  * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the Licence is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the Licence for the specific language governing
15  * permissions and limitations under the Licence.
16  */
22 #include "Exploration.h"
23 
24 #include <utility>
25 
26 namespace SimPT_Parex {
27 
32 {
33 public:
41  FileExploration(const std::string& name, const std::vector<std::pair<std::string, boost::property_tree::ptree>>& files, const boost::property_tree::ptree& preferences);
42 
48  FileExploration(const boost::property_tree::ptree& pt);
49 
53  FileExploration(const FileExploration& other);
54 
59 
63  virtual ~FileExploration() {};
64 
68  virtual FileExploration* Clone() const;
69 
73  virtual std::vector<std::string> GetParameters() const;
74 
80  virtual std::vector<std::string> GetValues(unsigned int index) const;
81 
85  virtual unsigned int GetNumberOfTasks() const;
86 
91  virtual SimTask* CreateTask(unsigned int index) const;
92 
93 
110  virtual boost::property_tree::ptree ToPtree() const;
111 
112 private:
118  virtual void ReadPtree(const boost::property_tree::ptree& pt);
119 
120 private:
121  std::vector<std::string> m_file_names;
122  std::vector<boost::property_tree::ptree> m_file_contents;
123 };
124 
125 } // namespace
126 
127 #endif // end-of-include-guard
Interface for Exploration.
virtual boost::property_tree::ptree ToPtree() const
Convert the exploration to a ptree.
virtual FileExploration * Clone() const
Clone function.
Class describing a file-based exploration and its simulation tasks.
virtual ~FileExploration()
Destructor.
virtual std::vector< std::string > GetParameters() const
Returns all the parameters in the exploration.
FileExploration & operator=(const FileExploration &other)
Assignment operator.
virtual std::vector< std::string > GetValues(unsigned int index) const
Return the values of a certain task.
virtual unsigned int GetNumberOfTasks() const
Returns the number of tasks the exploration currently contains.
FileExploration(const std::string &name, const std::vector< std::pair< std::string, boost::property_tree::ptree >> &files, const boost::property_tree::ptree &preferences)
Constructor.
Namespace for SimPT parameter explorer package.
Definition: Client.cpp:52
Contains all information needed for a transmitable simulation task.
Definition: SimTask.h:31
Class describing a generic exploration.
Definition: Exploration.h:33
virtual SimTask * CreateTask(unsigned int index) const
Creates a task with the parameters on the given index.