org.ptolemy.fmi
Class FMICoSimulationCapabilities

java.lang.Object
  org.ptolemy.fmi.FMICoSimulationCapabilities

public class FMICoSimulationCapabilities
extends java.lang.Object

An object that represents the the capabilities of a FMI co-simulation slave.

A Functional Mock-up Unit file is a .fmu file in zip format that contains a .xml file named "modelDescription.xml". The xml file may optionally contain a "Implementation" element that will contain either a "CoSimulation_Standalone" element or a "CoSimulation_Tool" element. Those two elements will contain a "Capabilities" element that has attributes that define the capabilities of the slave. This class has public fields that correspond to the attributes of the "Capabilities" element. The name of this class is taken from the FMI specification.

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

Version:

$Id: FMICoSimulationCapabilities.java 66133 2013-04-25 21:59:22Z cxh $

Author:

Christopher Brooks

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Field Summary

boolean	canBeInstantiatedOnlyOncePerProcess True if only one FMU can be instantiated per process.
boolean	canHandleEvents True if the step size can be zero.
boolean	canHandleVariableCommunicationStepSize True if the slave ignores the allocateMemory() /** True if the slave can handle a variable step size.
boolean	canInterpolateInputs True if slave can interpolate inputs.
boolean	canNotUseMemoryManagementFunctions True if the slave ignores the allocateMemory() and freeMemory() callback functions and the slave uses its own memory management.
boolean	canRejectSteps True if the slave can discard and repeat a step.
boolean	canRunAsynchronuously True if the slave can run the fmiDoStep() call asynchronously.
boolean	canSignalEvents True if the slave can signal events during a communication step.
int	maxOutputDerivativeOrder The slave can supply derivatives with a maximum order.n The default value is 0.

Constructor Summary

FMICoSimulationCapabilities()
Create an empty Capability.

FMICoSimulationCapabilities(org.w3c.dom.Element element)
Create a FMICoSimulationCapability from an XML Element.

Method Summary

java.lang.String

toString() Return a description of the fields that are true or non-zero.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

FMICoSimulationCapabilities

public FMICoSimulationCapabilities()

Create an empty Capability.

FMICoSimulationCapabilities

public FMICoSimulationCapabilities(org.w3c.dom.Element element)

Create a FMICoSimulationCapability from an XML Element.

Parameters:

element - The XML Element that contains attributes.

Method Detail

toString

public java.lang.String toString()

Return a description of the fields that are true or non-zero.

Overrides:

toString in class java.lang.Object

Returns:

The true or non-zero fields