Values.h

Go to the documentation of this file.

/*
 * This file is part of OpenModelica.
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
 * c/o Linköpings universitet, Department of Computer and Information Science,
 * SE-58183 Linköping, Sweden.
 *
 * All rights reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
 * Public License (OSMC-PL) are obtained from OSMC, either from the above
 * address, from the URLs:
 * http://www.openmodelica.org or
 * https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica,
 * and in the OpenModelica distribution.
 *
 * GNU AGPL version 3 is obtained from:
 * https://www.gnu.org/licenses/licenses.html#GPL
 *
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
 *
 * See the full OSMC Public License conditions for more details.
 *
 */
 
#ifndef _OMS_VALUES_H_
#define _OMS_VALUES_H_
 
#include "ComRef.h"
#include "OMSFileSystem.h"
#include "Snapshot.h"
#include "OMSimulator/Types.h"
 
#include <map>
#include <pugixml.hpp>
 
namespace oms
{
  class Values
  {
  public:
    Values();
    ~Values();
 
    oms_status_enu_t setBoolean(const ComRef& cref, bool value);
    oms_status_enu_t setInteger(const ComRef& cref, int value);
    oms_status_enu_t setReal(const ComRef& cref, double value);
    oms_status_enu_t setString(const ComRef& cref, const std::string& value);
    oms_status_enu_t setUnit(const ComRef& cref, const std::string& value);
    void setUnitDefinitions(const ComRef& cref);
    void getFilteredUnitDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& unitDefinitions);
    void getFilteredEnumerationDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& enumerationDefinitions);
    void updateModelDescriptionRealStartValue(const ComRef& cref, double value);
    void updateModelDescriptionIntegerStartValue(const ComRef& cref, int value);
    void updateModelDescriptionBooleanStartValue(const ComRef& cref, bool value);
    void updateModelDescriptionStringStartValue(const ComRef& cref, std::string value);
 
    void updateModelDescriptionVariableUnit(const ComRef& cref, const std::string& value);
    void copyModelDescriptionUnitToResources(Values& value);
 
    oms_status_enu_t getBoolean(const ComRef& cref, bool& value);
    oms_status_enu_t getInteger(const ComRef& cref, int& value);
    oms_status_enu_t getReal(const ComRef& cref, double& value);
    oms_status_enu_t getString(const ComRef& cref, std::string& value);
 
    oms_status_enu_t setBooleanResources(const ComRef& cref, bool value, const ComRef& fullCref, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t setIntegerResources(const ComRef& cref, int value, const ComRef& fullCref, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t setRealResources(const ComRef& cref, double value, const ComRef& fullCref, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t setStringResources(const ComRef& cref, const std::string& value, const ComRef& fullCref, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t setUnitResources(const ComRef& cref, const std::string& value, const ComRef& fullCref);
 
    oms_status_enu_t getBooleanResources(const ComRef& cref, bool& value, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t getIntegerResources(const ComRef& cref, int& value, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t getRealResources(const ComRef& cref, double& value, bool externalInput, oms_modelState_enu_t modelState);
    oms_status_enu_t getStringResources(const ComRef& cref, std::string& value, bool externalInput, oms_modelState_enu_t modelState);
 
    oms_status_enu_t getBooleanFromModeldescription(const ComRef& cref, bool& value);
    oms_status_enu_t getIntegerFromModeldescription(const ComRef& cref, int& value);
    oms_status_enu_t getRealFromModeldescription(const ComRef& cref, double& value);
    oms_status_enu_t getStringFromModeldescription(const ComRef& cref, std::string& value);
 
    std::string getUnit(ComRef& cref) const;
    std::string getUnitFromModeldescription(ComRef& cref) const;
    std::string getEnumerationTypeFromModeldescription(ComRef& cref) const;
    oms_status_enu_t exportToSSD(pugi::xml_node& node) const;
    oms_status_enu_t importFromSnapshot(const pugi::xml_node& node, const std::string& sspVersion, const Snapshot& snapshot, std::string variantName);
    oms_status_enu_t importFromSnapshot(const Snapshot& snapshot, const std::string& ssvFilePath, const std::string& ssmFilename);
    oms_status_enu_t deleteStartValue(const ComRef& cref);
    oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(Values& value, const ComRef& owner, std::vector<std::string>& warningList);
    oms_status_enu_t deleteStartValueInResources(const ComRef& cref);
 
    oms_status_enu_t deleteReferencesInSSD(const std::string& filename);
    oms_status_enu_t deleteResourcesInSSP(const std::string& filename);
 
    oms_status_enu_t exportToSSV(pugi::xml_node& ssvNode) const;
 
    oms_status_enu_t exportUnitDefinitions(Snapshot &snapshot, std::string filename, std::string variantName) const;
    oms_status_enu_t exportUnitDefinitionsToSSVTemplate(Snapshot &snapshot, std::string filename);
    void importUnitDefinitions(const pugi::xml_node& node);
    void importEnumerationDefinitions(const pugi::xml_node& node, std::string& enumTypeName);
 
    void exportToSSVTemplate(pugi::xml_node& ssvNode, const ComRef& cref);  
    void exportReduceSSV(pugi::xml_node& ssvNode, const ComRef& cref);  
 
    oms_status_enu_t exportToSSMTemplate(pugi::xml_node& ssmNode, const ComRef& cref);  
 
    oms_status_enu_t parseModelDescription(const filesystem::path& root, std::string& guid_); 
    oms_status_enu_t parseModelDescriptionFmi3(const filesystem::path& root, std::string& guid_); 
 
    oms_status_enu_t rename(const oms::ComRef& oldCref, const oms::ComRef& newCref);
    oms_status_enu_t renameInResources(const oms::ComRef& oldCref, const oms::ComRef& newCref);
 
    void exportParameterBindings(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const;
 
    bool hasResources(); 
 
  private:
    oms_status_enu_t exportStartValuesHelper(pugi::xml_node& node) const;
    void exportParameterMappingInline(pugi::xml_node& node) const;
    void exportParameterMappingToSSM(pugi::xml_node& node) const;
    oms_status_enu_t importStartValuesHelper(const pugi::xml_node& parameters);
 
    void parseModelStructureDependencies(std::string &dependencies, std::vector<int>& dependencyList);
 
    void importParameterMapping(const pugi::xml_node& parameterMapping);
    oms::ComRef getMappedCrefEntry(const ComRef& cref) const;
    bool isEntryReferencedInSSM(const ComRef& cref) const;
    bool empty() const;
 
  public:
    std::map<ComRef, bool> booleanStartValues;        
    std::map<ComRef, double> realStartValues;         
    std::map<ComRef, int> integerStartValues;         
    std::map<ComRef, std::string> stringStartValues;  
 
    std::map<ComRef, bool> booleanValues;        
    std::map<ComRef, double> realValues;         
    std::map<ComRef, int> integerValues;         
    std::map<ComRef, std::string> stringValues;  
 
    std::map<ComRef, bool> modelDescriptionBooleanStartValues;        
    std::map<ComRef, double> modelDescriptionRealStartValues;         
    std::map<ComRef, int> modelDescriptionIntegerStartValues;         
    std::map<ComRef, std::string> modelDescriptionStringStartValues;  
 
    std::map<int, std::vector<int>> modelStructureOutputs;            
    std::map<int, std::vector<int>> modelStructureDerivatives;        
    std::map<int, std::vector<int>> modelStructureInitialUnknowns;    
 
    std::map<int, bool> modelStructureOutputDependencyExist;
    std::map<int, bool> modelStructureDerivativesDependencyExist;
    std::map<int, bool> modelStructureInitialUnknownsDependencyExist;
 
    std::map<ComRef, std::string> modelDescriptionVariableUnits;  
    std::map<ComRef, std::string> variableUnits;  
 
    struct unitDefinitionsToExport
    {
      std::string unitName;
      std::string unitValue;
      std::map<std::string, std::string> baseUnit;
      bool exportUnit;
    };
    std::vector<unitDefinitionsToExport> unitDefinitionsToExportInSSP; 
 
    std::map<std::string, std::map<std::string, std::string>> modeldescriptionUnitDefinitions;  
 
    std::map<std::string, std::map<std::string, std::string>> modeldescriptionTypeDefinitions;  
    std::map<std::string, std::string> modeldescriptionEnumeration;  
 
    std::multimap<ComRef, ComRef> mappedEntry;  
 
    std::vector<Values> parameterResources; 
    std::map<std::string, Values> allresources; 
    std::string ssmFile = ""; 
    bool linkResources = true;
  };
}
 
#endif