org.javafmi.modeldescription.v2.CoSimulation 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.modeldescription.v2;

import org.simpleframework.xml.Attribute;
import org.simpleframework.xml.ElementList;
import org.simpleframework.xml.Root;

import java.util.List;

@Root(strict = false)
public class CoSimulation {

    @Attribute(required = true)
    private String modelIdentifier;
    @Attribute(required = false)
    private boolean needsExecutionTool;
    @Attribute(required = false)
    private boolean canHandleVariableCommunicationStepSize;
    @Attribute(required = false)
    private boolean canInterpolateInputs;
    @Attribute(required = false)
    private int maxOutputDerivativeOrder;
    @Attribute(required = false)
    private boolean canRunAsynchronuously;
    @Attribute(required = false)
    private boolean canBeInstantiatedOnlyOncePerProcess;
    @Attribute(required = false)
    private boolean canNotUseMemoryManagementFunctions;
    @Attribute(required = false)
    private boolean canGetAndSetFMUstate;
    @Attribute(required = false)
    private boolean canSerializeFMUstate;
    @Attribute(required = false)
    private boolean providesDirectionalDerivative;
    @ElementList(required = false)
    private List sourceFiles;
    private Capabilities capabilities;

    public String getModelIdentifier() {
        return modelIdentifier;
    }

    public Capabilities capabilities() {
        if (capabilities != null) return capabilities;
        capabilities = new Capabilities();
        if (needsExecutionTool) capabilities.add(Capabilities.NeedsExecutionTool);
        if (canHandleVariableCommunicationStepSize)
            capabilities.add(Capabilities.CanHandleVariableCommunicationStepSize);
        if (canInterpolateInputs) capabilities.add(Capabilities.CanInterpolateInputs);
        if (canRunAsynchronuously) capabilities.add(Capabilities.CanRunAsynchronously);
        if (canBeInstantiatedOnlyOncePerProcess)
            capabilities.add(Capabilities.CanBeInstantiatedOnlyOncePerProcess);
        if (canNotUseMemoryManagementFunctions) capabilities.add(Capabilities.CanNotUseMemoryManagementFunctions);
        if (canGetAndSetFMUstate) capabilities.add(Capabilities.CanGetAndSetFmuState);
        if (canSerializeFMUstate) capabilities.add(Capabilities.CanSerializeFmuState);
        if (providesDirectionalDerivative) capabilities.add(Capabilities.ProvidesDirectionalDerivatives);
        return capabilities;
    }

    public int getMaxOutputDerivativeOrder() {
        return maxOutputDerivativeOrder;
    }

    public List getSourceFiles() {
        return sourceFiles;
    }
}