org.javafmi.proxy.FmiProxyV2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fmu-wrapper Show documentation

javaFMI is a Java Library for the functional mock-up interface (or FMI). FMI defines a standardized interface to be used in computer simulations. The FMI Standard has beed developed by a large number of software companies and research centers that have worked in a cooperation project under the name of MODELISAR. This library addresses the connection of a java application with a FMU (functional mock-up unit).

There is a newer version: 2.26.5

Show newest version

/*
 *  Copyright 2013-2016 SIANI - ULPGC
 *
 *  This File is part of JavaFMI Project
 *
 *  JavaFMI Project is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License.
 *
 *  JavaFMI Project is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with JavaFMI. If not, see .
 */

package org.javafmi.proxy;

import org.javafmi.modeldescription.v2.Capabilities;
import org.javafmi.modeldescription.v2.ModelDescription;
import org.javafmi.proxy.v2.State;

public interface FmiProxyV2 extends FmiProxy {

    Status setDebugLogging(boolean loggingOn, String[] categories);

    Status setUpExperiment(boolean toleranceDefined, double tolerance, double startTime, boolean stopTimeDefined, double stopTime);

    Status enterInitializationMode();

    Status exitInitializationMode();

    ModelDescription getModelDescription();

    Status setRealInputDerivatives(int[] valueReferences, int[] orders, double[] values);

    double[] getRealOutputDerivatives(int[] valueReferences, int[] orders);

    State getState(State state);

    Status setState(State state);

    Status freeState(State state);

    int getStateSize(State state);

    byte[] serializeState(State state);

    State deserializeState(byte[] serializedState);

    void checkCapability(String method, Capabilities.Capability... capabilitiesToCheck);

    double[] getDirectionalDerivative(int[] unknownVariablesValueReferences, int[] knownVariablesValueReferences, double[] knownDifferential);
}