Package org.ptolemy.fmi

Class FMI20CoSimulationCapabilities

  • public class FMI20CoSimulationCapabilities
extends FMICapabilities
    An object that represents the the capabilities of a FMI co-simulation slave for FMI-2.0.

    A Functional Mock-up Unit file is a .fmu file in zip format that contains a .xml file named "modelDescription.xml". In FMI-2.0, the xml file may optionally contain a "CoSimulation" element that defines the capabilities of the CoSimulation FMU.

    FMI documentation may be found at https://fmi-standard.org/.

    FMI documentation may be found at http://www.modelisar.com/fmi.html.

    Since:
    Ptolemy II 10.0
    Version:
    $Id$, $Id$
    Author:
    Christopher Brooks
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)

    • Field Detail

      • canBeInstantiatedOnlyOncePerProcess

        public boolean canBeInstantiatedOnlyOncePerProcess
        True if only one FMU can be instantiated per process. The default value is false.

      • canHandleVariableCommunicationStepSize

        public boolean canHandleVariableCommunicationStepSize
        True if the slave ignores the allocateMemory() /** True if the slave can handle a variable step size. The default value is false.

      • canHandleEvents

        public boolean canHandleEvents
        True if the step size can be zero. The default value is false.

      • canInterpolateInputs

        public boolean canInterpolateInputs
        True if slave can interpolate inputs. The default value is false.

      • canNotUseMemoryManagementFunctions

        public boolean canNotUseMemoryManagementFunctions
        True if the slave ignores the allocateMemory() and freeMemory() callback functions and the slave uses its own memory management. The default value is false.

      • canRunAsynchronuously

        public boolean canRunAsynchronuously
        True if the slave can run the fmiDoStep() call asynchronously. The default value is false.

      • canRejectSteps

        public boolean canRejectSteps
        True if the slave can discard and repeat a step. The default value is false.

      • canSignalEvents

        public boolean canSignalEvents
        True if the slave can signal events during a communication step. If false, then the slave cannot signal events during the communication step. The default value is false.

      • maxOutputDerivativeOrder

        public int maxOutputDerivativeOrder
        The slave can supply derivatives with a maximum order.n The default value is 0.

    • Constructor Detail

      • FMI20CoSimulationCapabilities

        public FMI20CoSimulationCapabilities()
        Create an empty Capability.

      • FMI20CoSimulationCapabilities

        public FMI20CoSimulationCapabilities​(org.w3c.dom.Element element)
        Create a FMICoSimulationCapability from an XML Element.
        Parameters:
        element - The XML Element that contains attributes.