org.javafmi.wrapper.v2

Class Access

java.lang.Object

org.javafmi.wrapper.v2.Access

All Implemented Interfaces:

Access

public class Access
extends Object
implements Access

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Access(FmuProxy proxy, ModelDescription modelDescription)
	Access(Simulation simulation)

Method Summary

Modifier and Type	Method and Description
Status	cancelStep()
State	deserializeState(byte[] serializedState)
Status	doStep(double simulationTime, double stepSize)
Status	enterInitializationMode()
Status	exitInitializationMode()
void	freeInstance()
Status	freeState(State state)
boolean[]	getBoolean(int[] valueReference)
Capabilities	getCapabilities()
double[]	getDirectionalDerivative(int[] unknownValueReferences, int[] knownValueReferences, double[] knownDerivative)
double[]	getDirectionalDerivative(String knownVariable, String... unknownVariables) Deprecated.
double[][]	getDirectionalDerivatives(String[] unknownVariables, String[] knownVariables) Deprecated.
Object	getEnumeration(ScalarVariable modelVariable)
int[]	getInteger(int[] valueReference)
String[]	getKnownVariables()
String	getModelName()
double[]	getReal(int... valueReference)
double[]	getRealOutputDerivatives(String[] realInputNames)
State	getState(State state)
int	getStateSize(State state)
String[]	getString(int[] valueReference)
String[]	getUnknownVariables()
int	getValueReference(String variable)
int[]	getValueReferences(String[] variables)
String	getVersion()
Status	initialize(double startTime, double stopTime)
void	instantiate(double timeout)
Status	reset()
byte[]	serializeState(State state)
Status	setBoolean(int[] valueReference, boolean[] booleanValue)
Status	setDebugLogging(boolean loggingOn, int numberOfCategories, String[] categories)
Status	setInteger(int[] valueReference, int[] intValue)
Status	setReal(int[] valueReference, double[] doubleValue)
Status	setRealInputDerivatives(String[] realInputNames, double[] derivatives)
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

Access

public Access(Simulation simulation)

Access

protected Access(FmuProxy proxy,
                 ModelDescription modelDescription)

Method Detail

getVersion

public String getVersion()

Specified by:

getVersion in interface Access

getKnownVariables

public String[] getKnownVariables()

getUnknownVariables

public String[] getUnknownVariables()

getDirectionalDerivatives

@Deprecated
public double[][] getDirectionalDerivatives(String[] unknownVariables,
                                                        String[] knownVariables)

Deprecated.

getDirectionalDerivative

@Deprecated
public double[] getDirectionalDerivative(String knownVariable,
                                                     String... unknownVariables)

Deprecated.

getModelName

public String getModelName()

doStep

public Status doStep(double simulationTime,
                     double stepSize)

cancelStep

public Status cancelStep()

terminate

public Status terminate()

freeInstance

public void freeInstance()

reset

public Status reset()

getReal

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

getInteger

public int[] getInteger(int[] valueReference)

getBoolean

public boolean[] getBoolean(int[] valueReference)

getString

public String[] getString(int[] valueReference)

getEnumeration

public Object getEnumeration(ScalarVariable modelVariable)

setReal

public Status setReal(int[] valueReference,
                      double[] doubleValue)

setInteger

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

setBoolean

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

setString

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

enterInitializationMode

public Status enterInitializationMode()

exitInitializationMode

public Status exitInitializationMode()

setUpExperiment

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

setDebugLogging

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

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)

instantiate

public void instantiate(double timeout)

initialize

public Status initialize(double startTime,
                         double stopTime)

setRealInputDerivatives

public Status setRealInputDerivatives(String[] realInputNames,
                                      double[] derivatives)

getRealOutputDerivatives

public double[] getRealOutputDerivatives(String[] realInputNames)

getValueReferences

public int[] getValueReferences(String[] variables)

getValueReference

public int getValueReference(String variable)

getCapabilities

public Capabilities getCapabilities()

getDirectionalDerivative

public double[] getDirectionalDerivative(int[] unknownValueReferences,
                                         int[] knownValueReferences,
                                         double[] knownDerivative)