Miind
SimulationRunParameter.hpp
Go to the documentation of this file.
1 // Copyright (c) 2005 - 2012 Marc de Kamps
2 // 2012 David-Matthias Sichau
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6 //
7 // * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
9 // and/or other materials provided with the distribution.
10 // * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software
11 // without specific prior written permission.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
15 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
16 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
17 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 //
19 
20 #ifndef MPILIB_SIMULATIONRUNPARAMETER_HPP_
21 #define MPILIB_SIMULATIONRUNPARAMETER_HPP_
22 
23 #include <string>
26 
27 namespace MPILib {
29 
47 
49 public:
50 
65  Number max_iter, Time t_begin, Time t_end, Time t_report,
66  Time t_step, const std::string& name_log ="", Time t_state_report = 0, bool bOnCanvas = false);
67 
73 
79  operator=(const SimulationRunParameter& parameter);
80 
85  Time getTBegin() const;
86 
91  Time getTEnd() const;
92 
97  Time getTReport() const;
98 
103  Time getTStep() const;
104 
109  Time getTState() const;
110 
115  std::string getLogName() const;
116 
122 
128 
129 private:
130 
132 
134 
139 
140  std::string _logFileName;
141 
143 
145 };
146 
147 } // end of namespace MPILib
148 
149 #endif // MPILIB_SIMULATIONRUNPARAMETER_HPP_ include guard
unsigned int Number
double Time
SimulationRunParameter(const report::handler::AbstractReportHandler &handler, Number max_iter, Time t_begin, Time t_end, Time t_report, Time t_step, const std::string &name_log="", Time t_state_report=0, bool bOnCanvas=false)
SimulationRunParameter & operator=(const SimulationRunParameter &parameter)
const report::handler::AbstractReportHandler & getHandler() const
const report::handler::AbstractReportHandler * _pHandler
Parameter determining how a simulation is run. Specifiying begin and end time, log file names...