/*

* PMSF FMU Framework for FMI 2.0 Co-Simulation FMUs

*

* (C) 2016 -- 2018 PMSF IT Consulting Pierre R. Mai

*

* This Source Code Form is subject to the terms of the Mozilla Public

* License, v. 2.0. If a copy of the MPL was not distributed with this

* file, You can obtain one at http://mozilla.org/MPL/2.0/.

*/

using namespace std;

#ifndef FMU_SHARED_OBJECT

#define FMI2_FUNCTION_PREFIX OSMPDummySource_

#endif

#include "fmi2Functions.h"

/*

* Logging Control

*

* Logging is controlled via three definitions:

*

* - If PRIVATE_LOG_PATH is defined it gives the name of a file

* that is to be used as a private log file.

* - If PUBLIC_LOGGING is defined then we will (also) log to

* the FMI logging facility where appropriate.

* - If VERBOSE_FMI_LOGGING is defined then logging of basic

* FMI calls is enabled, which can get very verbose.

*/

/*

* Variable Definitions

*

* Define FMI_*_LAST_IDX to the zero-based index of the last variable

* of the given type (0 if no variables of the type exist). This

* ensures proper space allocation, initialisation and handling of

* the given variables in the template code. Optionally you can

* define FMI_TYPENAME_VARNAME_IDX definitions (e.g. FMI_REAL_MYVAR_IDX)

* to refer to individual variables inside your code, or for example

* FMI_REAL_MYARRAY_OFFSET and FMI_REAL_MYARRAY_SIZE definitions for

* array variables.

*/

/* Boolean Variables */

#define FMI_BOOLEAN_VALID_IDX 0

#define FMI_BOOLEAN_USE_VIEWER_IDX 1

#define FMI_BOOLEAN_LAST_IDX FMI_BOOLEAN_USE_VIEWER_IDX

#define FMI_BOOLEAN_VARS (FMI_BOOLEAN_LAST_IDX+1)

/* Integer Variables */

#define FMI_INTEGER_TRAFFICUPDATE_IN_BASELO_IDX 0

#define FMI_INTEGER_TRAFFICUPDATE_IN_BASEHI_IDX 1

#define FMI_INTEGER_TRAFFICUPDATE_IN_SIZE_IDX 2

#define FMI_INTEGER_SENSORVIEW_OUT_BASELO_IDX 3

#define FMI_INTEGER_SENSORVIEW_OUT_BASEHI_IDX 4

#define FMI_INTEGER_SENSORVIEW_OUT_SIZE_IDX 5

#define FMI_INTEGER_TRAFFICCOMMANDUPDATE_IN_BASELO_IDX 6

#define FMI_INTEGER_TRAFFICCOMMANDUPDATE_IN_BASEHI_IDX 7

#define FMI_INTEGER_TRAFFICCOMMANDUPDATE_IN_SIZE_IDX 8

#define FMI_INTEGER_TRAFFICCOMMAND_OUT_BASELO_IDX 9

#define FMI_INTEGER_TRAFFICCOMMAND_OUT_BASEHI_IDX 10

#define FMI_INTEGER_TRAFFICCOMMAND_OUT_SIZE_IDX 11

#define FMI_INTEGER_LAST_IDX FMI_INTEGER_TRAFFICCOMMAND_OUT_SIZE_IDX

#define FMI_INTEGER_VARS (FMI_INTEGER_LAST_IDX+1)

/* Real Variables */

#define FMI_REAL_LAST_IDX 0

#define FMI_REAL_VARS (FMI_REAL_LAST_IDX+1)

/* String Variables */

#define FMI_STRING_XOSC_PATH_IDX 0

#define FMI_STRING_ESMINI_ARGS_IDX 1

#define FMI_STRING_LAST_IDX FMI_STRING_ESMINI_ARGS_IDX

#define FMI_STRING_VARS (FMI_STRING_LAST_IDX+1)

#include <iostream>

#include <fstream>

#include <string>

#include <cstdarg>

#include <set>

#undef min

#undef max

#include "osi_sensorview.pb.h"

#include "osi_trafficcommand.pb.h"

/* FMU Class */

class EsminiOsiSource {

public:

/* FMI2 Interface mapped to C++ */

EsminiOsiSource(fmi2String theinstanceName, fmi2Type thefmuType, fmi2String thefmuGUID, fmi2String thefmuResourceLocation, const fmi2CallbackFunctions* thefunctions, fmi2Boolean thevisible, fmi2Boolean theloggingOn);

~EsminiOsiSource();

fmi2Status SetDebugLogging(fmi2Boolean theloggingOn,size_t nCategories, const fmi2String categories[]);

static fmi2Component Instantiate(fmi2String instanceName, fmi2Type fmuType, fmi2String fmuGUID, fmi2String fmuResourceLocation, const fmi2CallbackFunctions* functions, fmi2Boolean visible, fmi2Boolean loggingOn);

fmi2Status SetupExperiment(fmi2Boolean toleranceDefined, fmi2Real tolerance, fmi2Real startTime, fmi2Boolean stopTimeDefined, fmi2Real stopTime);

fmi2Status EnterInitializationMode();

fmi2Status ExitInitializationMode();

fmi2Status DoStep(fmi2Real currentCommunicationPoint, fmi2Real communicationStepSize, fmi2Boolean noSetFMUStatePriorToCurrentPointfmi2Component);

fmi2Status Terminate();

fmi2Status Reset();

void FreeInstance();

fmi2Status GetReal(const fmi2ValueReference vr[], size_t nvr, fmi2Real value[]);

fmi2Status GetInteger(const fmi2ValueReference vr[], size_t nvr, fmi2Integer value[]);

fmi2Status GetBoolean(const fmi2ValueReference vr[], size_t nvr, fmi2Boolean value[]);

fmi2Status GetString(const fmi2ValueReference vr[], size_t nvr, fmi2String value[]);

fmi2Status SetReal(const fmi2ValueReference vr[], size_t nvr, const fmi2Real value[]);

fmi2Status SetInteger(const fmi2ValueReference vr[], size_t nvr, const fmi2Integer value[]);

fmi2Status SetBoolean(const fmi2ValueReference vr[], size_t nvr, const fmi2Boolean value[]);

fmi2Status SetString(const fmi2ValueReference vr[], size_t nvr, const fmi2String value[]);

bool get_slave_terminated() { return fmiSlaveTerminated; };

protected:

/* Internal Implementation */

fmi2Status doInit();

fmi2Status doStart(fmi2Boolean toleranceDefined, fmi2Real tolerance, fmi2Real startTime, fmi2Boolean stopTimeDefined, fmi2Real stopTime);

fmi2Status doEnterInitializationMode();

fmi2Status doExitInitializationMode();

fmi2Status doCalc(fmi2Real currentCommunicationPoint, fmi2Real communicationStepSize, fmi2Boolean noSetFMUStatePriorToCurrentPointfmi2Component);

fmi2Status doTerm();

void doFree();

protected:

/* Private File-based Logging just for Debugging */

#ifdef PRIVATE_LOG_PATH

static ofstream private_log_file;

#endif

static void fmi_verbose_log_global(const char* format, ...) {

#ifdef VERBOSE_FMI_LOGGING

#ifdef PRIVATE_LOG_PATH

va_list ap;

va_start(ap, format);

char buffer[1024];

if (!private_log_file.is_open())

private_log_file.open(PRIVATE_LOG_PATH, ios::out | ios::app);

if (private_log_file.is_open()) {

#ifdef _WIN32

vsnprintf_s(buffer, 1024, format, ap);

#else

vsnprintf(buffer, 1024, format, ap);

#endif

private_log_file << "OSMPDummySource" << "::Global:FMI: " << buffer << endl;

private_log_file.flush();

}

#endif

#endif

}

void internal_log(const char* category, const char* format, va_list arg)

{

#if defined(PRIVATE_LOG_PATH) || defined(PUBLIC_LOGGING)

char buffer[1024];

#ifdef _WIN32

vsnprintf_s(buffer, 1024, format, arg);

#else

vsnprintf(buffer, 1024, format, arg);

#endif

#ifdef PRIVATE_LOG_PATH

if (!private_log_file.is_open())

private_log_file.open(PRIVATE_LOG_PATH, ios::out | ios::app);

if (private_log_file.is_open()) {

private_log_file << "OSMPDummySource" << "::" << instanceName << "<" << ((void*)this) << ">:" << category << ": " << buffer << endl;

private_log_file.flush();

}

#endif

#ifdef PUBLIC_LOGGING

if (loggingOn && loggingCategories.count(category))

functions.logger(functions.componentEnvironment,instanceName.c_str(),fmi2OK,category,buffer);

#endif

#endif

}

void fmi_verbose_log(const char* format, ...) {

#if defined(VERBOSE_FMI_LOGGING) && (defined(PRIVATE_LOG_PATH) || defined(PUBLIC_LOGGING))

va_list ap;

va_start(ap, format);

internal_log("FMI",format,ap);

va_end(ap);

#endif

}

/* Normal Logging */

void normal_log(const char* category, const char* format, ...) {

#if defined(PRIVATE_LOG_PATH) || defined(PUBLIC_LOGGING)

va_list ap;

va_start(ap, format);

internal_log(category,format,ap);

va_end(ap);

#endif

}

protected:

/* Members */

string instanceName;

fmi2Type fmuType;

string fmuGUID;

string fmuResourceLocation;

bool visible;

bool loggingOn;

bool fmiSlaveTerminated;

set<string> loggingCategories;

fmi2CallbackFunctions functions;

fmi2Boolean boolean_vars[FMI_BOOLEAN_VARS];

fmi2Integer integer_vars[FMI_INTEGER_VARS];

fmi2Real real_vars[FMI_REAL_VARS];

string string_vars[FMI_STRING_VARS];

string* currentBufferSVOut;

string* lastBufferSVOut;

string* currentBufferTCOut;

string* lastBufferTCOut;

/* Simple Accessors */

fmi2Boolean fmi_valid() { return boolean_vars[FMI_BOOLEAN_VALID_IDX]; }

void set_fmi_valid(fmi2Boolean value) { boolean_vars[FMI_BOOLEAN_VALID_IDX]=value; }

fmi2Boolean fmi_use_viewer() { return boolean_vars[FMI_BOOLEAN_USE_VIEWER_IDX]; }

void set_fmi_use_viewer(fmi2Boolean value) { boolean_vars[FMI_BOOLEAN_USE_VIEWER_IDX]=value; }

string fmi_xosc_path() { return string_vars[FMI_STRING_XOSC_PATH_IDX]; }

void set_fmi_xosc_path(string value) { string_vars[FMI_STRING_XOSC_PATH_IDX]=value; }

string fmi_esmini_args() { return string_vars[FMI_STRING_ESMINI_ARGS_IDX]; }

void set_fmi_esmini_args(string value) { string_vars[FMI_STRING_ESMINI_ARGS_IDX]=value; }

/* Protocol Buffer Accessors */

bool get_fmi_traffic_update_in(osi3::TrafficUpdate& data);

void set_fmi_sensor_view_out(const osi3::SensorView& data);

void reset_fmi_sensor_view_out();

//bool get_fmi_traffic_command_update_in(osi3::TrafficCommandUpdate& data); //TODO: Wait for OSI update

void set_fmi_traffic_command_out(const osi3::TrafficCommand& data);

void reset_fmi_traffic_command_out();

};