org.javafmi.modeldescription.v2.Capabilities 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).

The newest version!

/*
 *  Copyright 2013-2018 - Monentia
 *
 * Daccosim is a collaborative development effort between EDF (France),
 *  CentraleSupélec (France), EIFER Institute (Germany), SIANI institute (Spain)
 *  and Monentia S.L. (Spain)
 *
 *  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 java.util.ArrayList;
import java.util.List;

public class Capabilities {
    public static final Capability NeedsExecutionTool = new Capability("needsExecutionTool");
    public static final Capability CanHandleVariableCommunicationStepSize = new Capability("canHandleVariableCommunicationStepSize");
    public static final Capability CanInterpolateInputs = new Capability("canInterpolateInputs");
    public static final Capability CanRunAsynchronuously = new Capability("canRunAsynchronuously");
    public static final Capability CanBeInstantiatedOnlyOncePerProcess = new Capability("canBeInstantiatedOnlyOncePerProcess");
    public static final Capability CanNotUseMemoryManagementFunctions = new Capability("canNotUseMemoryManagementFunctions");
    public static final Capability CanGetAndSetFMUState = new Capability("canGetAndSetFMUState");
    public static final Capability CanSerializeFMUState = new Capability("canSerializeFMUState");
    public static final Capability ProvidesDirectionalDerivative = new Capability("providesDirectionalDerivative");
    private List capabilities;

    public Capabilities() {
        this.capabilities = new ArrayList<>();
    }

    public boolean check(Capability capability) {
        return capabilities.contains(capability);
    }

    public void add(Capability capability) {
        capabilities.add(capability);
    }

    public static class Capability {
        private String name;

        public Capability(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }
    }
}