fmu2.hpp

Go to the documentation of this file.

#ifndef CORAL_FMI_FMU2_HPP
#define CORAL_FMI_FMU2_HPP

#include <memory>
#include <string>
#include <vector>

#include <boost/filesystem/path.hpp>

#include <coral/config.h>
#include <coral/fmi/fmu.hpp>
#include <coral/fmi/importer.hpp>
#include <coral/model.hpp>


// Forward declarations to avoid external dependency on FMI Library
struct fmi2_import_t;
typedef unsigned int fmi2_value_reference_t;


namespace coral
{
namespace fmi
{

#ifdef _WIN32
class AdditionalPath;
#endif
class SlaveInstance2;


class FMU2 : public coral::fmi::FMU, public std::enable_shared_from_this<FMU2>
{
private:
    // Only Importer is allowed to instantiate this class.
    friend std::shared_ptr<coral::fmi::FMU> coral::fmi::Importer::Import(
        const boost::filesystem::path&);
    FMU2(
        std::shared_ptr<coral::fmi::Importer> importer,
        const boost::filesystem::path& fmuDir);

public:
    // Disable copy and move
    FMU2(const FMU2&) = delete;
    FMU2& operator=(const FMU2&) = delete;
    FMU2(FMU2&&) = delete;
    FMU2& operator=(FMU2&&) = delete;

    ~FMU2();

    // coral::fmi::FMU methods
    coral::fmi::FMIVersion FMIVersion() const override;
    const coral::model::SlaveTypeDescription& Description() const override;
    std::shared_ptr<coral::fmi::SlaveInstance> InstantiateSlave() override;
    std::shared_ptr<coral::fmi::Importer> Importer() const override;

    std::shared_ptr<SlaveInstance2> InstantiateSlave2();

    const boost::filesystem::path& Directory() const;

    fmi2_value_reference_t FMIValueReference(coral::model::VariableID variable)
        const;

    fmi2_import_t* FmilibHandle() const;

private:
    std::shared_ptr<coral::fmi::Importer> m_importer;
    boost::filesystem::path m_dir;

    fmi2_import_t* m_handle;
    std::unique_ptr<coral::model::SlaveTypeDescription> m_description;
    std::vector<fmi2_value_reference_t> m_valueReferences;
    std::vector<std::weak_ptr<SlaveInstance2>> m_instances;

#ifdef _WIN32
    // Workaround for VIPROMA-67 (FMU DLL search paths on Windows).
    std::unique_ptr<AdditionalPath> m_additionalDllSearchPath;
#endif
};


class SlaveInstance2 : public coral::fmi::SlaveInstance
{
private:
    // Only FMU2 is allowed to instantiate this class.
    friend std::shared_ptr<SlaveInstance2> coral::fmi::FMU2::InstantiateSlave2();
    SlaveInstance2(std::shared_ptr<coral::fmi::FMU2> fmu);

public:
    // Disable copy and move.
    SlaveInstance2(const SlaveInstance2&) = delete;
    SlaveInstance2& operator=(const SlaveInstance2&) = delete;
    SlaveInstance2(SlaveInstance2&&) = delete;
    SlaveInstance2& operator=(SlaveInstance2&&) = delete;

    ~SlaveInstance2() CORAL_NOEXCEPT;

    // coral::slave::Instance methods
    coral::model::SlaveTypeDescription TypeDescription() const override;

    void Setup(
        const std::string& slaveName,
        const std::string& executionName,
        coral::model::TimePoint startTime,
        coral::model::TimePoint stopTime,
        bool adaptiveStepSize,
        double relativeTolerance) override;

    void StartSimulation() override;
    void EndSimulation() override;

    bool DoStep(coral::model::TimePoint currentT, coral::model::TimeDuration deltaT) override;

    double GetRealVariable(coral::model::VariableID variable) const override;
    int GetIntegerVariable(coral::model::VariableID variable) const override;
    bool GetBooleanVariable(coral::model::VariableID variable) const override;
    std::string GetStringVariable(coral::model::VariableID variable) const override;

    bool SetRealVariable(coral::model::VariableID variable, double value) override;
    bool SetIntegerVariable(coral::model::VariableID variable, int value) override;
    bool SetBooleanVariable(coral::model::VariableID variable, bool value) override;
    bool SetStringVariable(coral::model::VariableID variable, const std::string& value) override;

    // coral::fmi::SlaveInstance methods
    std::shared_ptr<coral::fmi::FMU> FMU() const override;

    std::shared_ptr<coral::fmi::FMU2> FMU2() const;

    fmi2_import_t* FmilibHandle() const;

private:
    std::shared_ptr<coral::fmi::FMU2> m_fmu;
    fmi2_import_t* m_handle;

    bool m_setupComplete = false;
    bool m_simStarted = false;

    std::string m_instanceName;
};


}} // namespace
#endif // header guard