OMCompiler/SimulationRuntime/cpp/Core/SimController/ISimObjects.h
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /* | ||
| 2 | * This file belongs to the OpenModelica Run-Time System | ||
| 3 | * | ||
| 4 | * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC), c/o Linköpings | ||
| 5 | * universitet, Department of Computer and Information Science, SE-58183 Linköping, Sweden. All rights | ||
| 6 | * reserved. | ||
| 7 | * | ||
| 8 | * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF THE BSD NEW LICENSE OR THE | ||
| 9 | * AGPL VERSION 3 LICENSE OR THE OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8. ANY | ||
| 10 | * USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S | ||
| 11 | * ACCEPTANCE OF THE BSD NEW LICENSE OR THE OSMC PUBLIC LICENSE OR THE AGPL | ||
| 12 | * VERSION 3, ACCORDING TO RECIPIENTS CHOICE. | ||
| 13 | * | ||
| 14 | * The OpenModelica software and the OSMC (Open Source Modelica Consortium) Public License | ||
| 15 | * (OSMC-PL) are obtained from OSMC, either from the above address, from the URLs: | ||
| 16 | * http://www.openmodelica.org or https://github.com/OpenModelica/ or | ||
| 17 | * http://www.ida.liu.se/projects/OpenModelica, and in the OpenModelica distribution. GNU | ||
| 18 | * AGPL version 3 is obtained from: https://www.gnu.org/licenses/licenses.html#GPL. The BSD NEW | ||
| 19 | * License is obtained from: http://www.opensource.org/licenses/BSD-3-Clause. | ||
| 20 | * | ||
| 21 | * This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 22 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY | ||
| 23 | * SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF | ||
| 24 | * OSMC-PL. | ||
| 25 | * | ||
| 26 | */ | ||
| 27 | |||
| 28 | #pragma once | ||
| 29 | /** @addtogroup coreSimcontroller | ||
| 30 | * | ||
| 31 | * @{ | ||
| 32 | */ | ||
| 33 | |||
| 34 | |||
| 35 | |||
| 36 | /** | ||
| 37 | * | ||
| 38 | */ | ||
| 39 | 80 | class ISimObjects | |
| 40 | { | ||
| 41 | |||
| 42 | public: | ||
| 43 | |||
| 44 | virtual ~ISimObjects() {}; | ||
| 45 | virtual weak_ptr<ISimData> LoadSimData(string modelKey) = 0; | ||
| 46 | /** | ||
| 47 | Creates SimVars object, stores all model variable in continuous block of memory | ||
| 48 | @param model name | ||
| 49 | @param dim_real number of all real variables (real algebraic vars,discrete algebraic vars, state vars, der state vars) | ||
| 50 | @param dim_int number of all integer variables integer algebraic vars | ||
| 51 | @param dim_bool number of all bool variables (boolean algebraic vars) | ||
| 52 | @param dim_pre_vars number of all pre variables (real algebraic vars,discrete algebraic vars, boolean algebraic vars, integer algebraic vars, state vars, der state vars) | ||
| 53 | @param dim_z number of all state variables | ||
| 54 | @param z_i start index of state vector in real_vars list | ||
| 55 | */ | ||
| 56 | virtual weak_ptr<ISimVars> LoadSimVars(string modelKey,size_t dim_real,size_t dim_int,size_t dim_bool,size_t dim_string,size_t dim_pre_vars,size_t dim_z,size_t z_i) = 0; | ||
| 57 | virtual weak_ptr<IHistory> LoadWriter(size_t) = 0; | ||
| 58 | |||
| 59 | virtual shared_ptr<ISimData> getSimData(string modelname) = 0; | ||
| 60 | virtual shared_ptr<ISimVars> getSimVars(string modelname) = 0; | ||
| 61 | virtual void eraseSimData(string modelname) = 0; | ||
| 62 | virtual void eraseSimVars(string modelname) = 0; | ||
| 63 | |||
| 64 | virtual ISimObjects* clone() = 0; | ||
| 65 | |||
| 66 | virtual shared_ptr<IAlgLoopSolverFactory> getAlgLoopSolverFactory() = 0; | ||
| 67 | }; | ||
| 68 | /** @} */ // end of coreSimcontroller | ||
| 69 |