org.javafmi.kernel.v2

Class FmuProxy

java.lang.Object

org.javafmi.kernel.v2.FmuProxy

All Implemented Interfaces:

FmuProxy

public class FmuProxy
extends Object
implements FmuProxy

Constructor Summary

Constructors

Constructor and Description
FmuProxy(FmuFile fmuFile)

Method Summary

Modifier and Type	Method and Description
Status	cancelStep()
void	checkCapability(String method, Capabilities.Capability... capabilitiesToCheck)
State	deserializeState(byte[] serializedState)
Status	doStep(double communicationPoint, double stepSize)
Status	enterInitializationMode()
Status	exitInitializationMode()
void	freeInstance()
Status	freeState(State state)
boolean[]	getBoolean(int... valueReference)
Capabilities	getCapabilities()
double[]	getDirectionalDerivative(int[] unknownVariablesValueReferences, int[] knownVariablesValueReferences, double[] knownDifferential)
Object	getEnumeration(ScalarVariable modelVariable)
int[]	getInteger(int... valueReference)
ModelDescription	getModelDescription()
double[]	getReal(int... valueReference)
double[]	getRealOutputDerivatives(int[] valueReferences, int[] orders)
State	getState(State state)
int	getStateSize(State state)
String[]	getString(int... valueReference)
String	getVersion()
Status	initialize(double startTime, double stopTime)
void	instantiate()
boolean	isTerminated()
Status	reset()
byte[]	serializeState(State state)
Status	setBoolean(int[] valueReference, boolean[] booleanValue)
Status	setDebugLogging(boolean loggingOn, String[] categories)
Status	setInteger(int[] valueReference, int[] intValue)
Status	setReal(int[] valueReferences, double[] doubleValues)
Status	setRealInputDerivatives(int[] valueReferences, int[] orders, double[] values)
Status	setState(State state)
Status	setString(int[] valueReference, String[] stringValue)
Status	setUpExperiment(boolean toleranceDefined, double tolerance, double startTime, boolean stopTimeDefined, double stopTime)
Status	terminate()

Methods inherited from class java.lang.Object

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

Constructor Detail

FmuProxy

public FmuProxy(FmuFile fmuFile)

Method Detail

getVersion

public String getVersion()

Specified by:

getVersion in interface FmuProxy

instantiate

public void instantiate()

Specified by:

instantiate in interface FmuProxy

freeInstance

public void freeInstance()

Specified by:

freeInstance in interface FmuProxy

setDebugLogging

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

initialize

public Status initialize(double startTime,
                         double stopTime)

Specified by:

initialize in interface FmuProxy

setUpExperiment

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

enterInitializationMode

public Status enterInitializationMode()

exitInitializationMode

public Status exitInitializationMode()

terminate

public Status terminate()

Specified by:

terminate in interface FmuProxy

reset

public Status reset()

Specified by:

reset in interface FmuProxy

getModelDescription

public ModelDescription getModelDescription()

Specified by:

getModelDescription in interface FmuProxy

setRealInputDerivatives

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

getRealOutputDerivatives

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

getReal

public double[] getReal(int... valueReference)

Specified by:

getReal in interface FmuProxy

getInteger

public int[] getInteger(int... valueReference)

Specified by:

getInteger in interface FmuProxy

getBoolean

public boolean[] getBoolean(int... valueReference)

Specified by:

getBoolean in interface FmuProxy

getString

public String[] getString(int... valueReference)

Specified by:

getString in interface FmuProxy

getEnumeration

public Object getEnumeration(ScalarVariable modelVariable)

Specified by:

getEnumeration in interface FmuProxy

setReal

public Status setReal(int[] valueReferences,
                      double[] doubleValues)

Specified by:

setReal in interface FmuProxy

setInteger

public Status setInteger(int[] valueReference,
                         int[] intValue)

Specified by:

setInteger in interface FmuProxy

setBoolean

public Status setBoolean(int[] valueReference,
                         boolean[] booleanValue)

Specified by:

setBoolean in interface FmuProxy

setString

public Status setString(int[] valueReference,
                        String[] stringValue)

Specified by:

setString in interface FmuProxy

getState

public State getState(State state)

setState

public Status setState(State state)

freeState

public Status freeState(State state)

getStateSize

public int getStateSize(State state)

serializeState

public byte[] serializeState(State state)

deserializeState

public State deserializeState(byte[] serializedState)

checkCapability

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

getDirectionalDerivative

public double[] getDirectionalDerivative(int[] unknownVariablesValueReferences,
                                         int[] knownVariablesValueReferences,
                                         double[] knownDifferential)

doStep

public Status doStep(double communicationPoint,
                     double stepSize)

Specified by:

doStep in interface FmuProxy

cancelStep

public Status cancelStep()

Specified by:

cancelStep in interface FmuProxy

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface FmuProxy

getCapabilities

public Capabilities getCapabilities()