org.intocps.fmi

Interface IFmiComponent

public interface IFmiComponent

Method Summary

Modifier and Type	Method and Description
Fmi2Status	doStep(double currentCommunicationPoint, double communicationStepSize, boolean noSetFMUStatePriorToCurrentPoint)
Fmi2Status	enterInitializationMode()
Fmi2Status	exitInitializationMode()
void	freeInstance()
Fmi2Status	freeState(IFmiComponentState state)
FmuResult<boolean[]>	getBooleans(long[] scalarValueIndices) Obtains the values of the selected scalar values
FmuResult<Boolean>	getBooleanStatus(Fmi2StatusKind kind)
FmuResult<double[]>	getDirectionalDerivative(long[] vUnknownRef, long[] vKnownRef, double[] dvKnown)
IFmu	getFmu()
FmuResult<int[]>	getInteger(long[] scalarValueIndices)
FmuResult<Integer>	getIntegerStatus(Fmi2StatusKind kind)
FmuResult<Double>	getMaxStepSize() Extension method suggested in Broman et al
FmuResult<double[]>	getReal(long[] scalarValueIndices) Obtains the values of the selected scalar values
FmuResult<double[]>	getRealOutputDerivatives(long[] scalarValueIndices, int[] order)
FmuResult<Double>	getRealStatus(Fmi2StatusKind kind)
FmuResult<IFmiComponentState>	getState()
FmuResult<Fmi2Status>	getStatus(Fmi2StatusKind kind)
FmuResult<String[]>	getStrings(long[] scalarValueIndices)
FmuResult<String>	getStringStatus(Fmi2StatusKind kind)
boolean	isValid()
Fmi2Status	reset()
Fmi2Status	setBooleans(long[] scalarValueIndices, boolean[] values)
Fmi2Status	setDebugLogging(boolean loggingOn, String[] categories)
Fmi2Status	setIntegers(long[] scalarValueIndices, int[] values)
Fmi2Status	setRealInputDerivatives(long[] scalarValueIndices, int[] order, double[] derivatives)
Fmi2Status	setReals(long[] scalarValueIndices, double[] values)
Fmi2Status	setState(IFmiComponentState state)
Fmi2Status	setStrings(long[] scalarValueIndices, String[] values)
Fmi2Status	setupExperiment(boolean toleranceDefined, double tolerance, double startTime, boolean stopTimeDefined, double stopTime)
Fmi2Status	terminate()

Method Detail

getFmu

IFmu getFmu()

setDebugLogging

Fmi2Status setDebugLogging(boolean loggingOn,
                           String[] categories)
                    throws FmuInvocationException

Throws:

FmuInvocationException

setupExperiment

Fmi2Status setupExperiment(boolean toleranceDefined,
                           double tolerance,
                           double startTime,
                           boolean stopTimeDefined,
                           double stopTime)
                    throws FmuInvocationException

Throws:

FmuInvocationException

enterInitializationMode

Fmi2Status enterInitializationMode()
                            throws FmuInvocationException

Throws:

FmuInvocationException

exitInitializationMode

Fmi2Status exitInitializationMode()
                           throws FmuInvocationException

Throws:

FmuInvocationException

reset

Fmi2Status reset()
          throws FmuInvocationException

Throws:

FmuInvocationException

setRealInputDerivatives

Fmi2Status setRealInputDerivatives(long[] scalarValueIndices,
                                   int[] order,
                                   double[] derivatives)
                            throws FmuInvocationException

Throws:

FmuInvocationException

getRealOutputDerivatives

FmuResult<double[]> getRealOutputDerivatives(long[] scalarValueIndices,
                                             int[] order)
                                      throws FmuInvocationException

Throws:

FmuInvocationException

getDirectionalDerivative

FmuResult<double[]> getDirectionalDerivative(long[] vUnknownRef,
                                             long[] vKnownRef,
                                             double[] dvKnown)
                                      throws FmuInvocationException

Throws:

FmuInvocationException

doStep

Fmi2Status doStep(double currentCommunicationPoint,
                  double communicationStepSize,
                  boolean noSetFMUStatePriorToCurrentPoint)
           throws FmuInvocationException

Parameters:

currentCommunicationPoint - Argument currentCommunicationPoint is the current communication point of the master (𝑡𝑐𝑖)

communicationStepSize - argument communicationStepSize is the communication step size (ℎ𝑐𝑖). The latter must be > 0.0. The slave must integrate until time instant 𝑡𝑐𝑖+1 = 𝑡𝑐𝑖 + ℎ𝑐

noSetFMUStatePriorToCurrentPoint - Argument noSetFMUStatePriorToCurrentPoint is fmi2True if fmi2SetFMUState will no longer be called for time instants prior to currentCommunicationPoint in this simulation run

Returns:

• fmi2OK - if the communication step was computed successfully until its end.
• fmi2Discard – if the slave computed successfully only a subinterval of the communication step. The master can call the appropriate fmi2GetXXXStatus functions to get further information. If possible, the master should retry the simulation with a shorter communication step size. [Redoing a step is only possible if the FMU state has been recorded at the beginning of the current (failed) step with fmi2GetFMUState. Redoing a step is performed by calling fmi2SetFMUState and afterwards calling fmi2DoStep with the new communicationStepSize. Note, it is not possible to change currentCommunicationPoint in such a call.]
• fmi2Error – the communication step could not be carried out at all. The master can try to repeat the step with other input values and/or a different communication step size in the same way as described in the fmi2Discard case above.
• fmi2Fatal – if an error occurred which corrupted the FMU irreparably. [The master should stop the simulation run immediatlely.] See section 2.1.3 for details.
• fmi2Pending – is returned if the slave executes the function asynchronously. That means the slave starts the computation but returns immediately. The master has to call fmi2GetStatus(...,fmi2DoStep,...) to find out, if the slave is done. An alternative is to wait until the callback function fmi2StepFinished is called by the slave. fmi2CancelStep can be called to cancel the current computation. It is not allowed to call any other function during a pending fmi2DoStep

Throws:

FmuInvocationException - ..

getReal

FmuResult<double[]> getReal(long[] scalarValueIndices)
                     throws FmuInvocationException

Obtains the values of the selected scalar values

Parameters:

scalarValueIndices - svs

Returns:

result

Throws:

FmuInvocationException

getInteger

FmuResult<int[]> getInteger(long[] scalarValueIndices)
                     throws FmuInvocationException

Throws:

FmuInvocationException

getBooleans

FmuResult<boolean[]> getBooleans(long[] scalarValueIndices)
                          throws FmuInvocationException

Obtains the values of the selected scalar values

Parameters:

scalarValueIndices - svs

Returns:

result

Throws:

FmuInvocationException

getStrings

FmuResult<String[]> getStrings(long[] scalarValueIndices)
                        throws FmuInvocationException

Throws:

FmuInvocationException

setBooleans

Fmi2Status setBooleans(long[] scalarValueIndices,
                       boolean[] values)
                throws InvalidParameterException,
                       FmiInvalidNativeStateException

Throws:

InvalidParameterException

FmiInvalidNativeStateException

setReals

Fmi2Status setReals(long[] scalarValueIndices,
                    double[] values)
             throws InvalidParameterException,
                    FmiInvalidNativeStateException

Throws:

InvalidParameterException

FmiInvalidNativeStateException

setIntegers

Fmi2Status setIntegers(long[] scalarValueIndices,
                       int[] values)
                throws InvalidParameterException,
                       FmiInvalidNativeStateException

Throws:

InvalidParameterException

FmiInvalidNativeStateException

setStrings

Fmi2Status setStrings(long[] scalarValueIndices,
                      String[] values)
               throws InvalidParameterException,
                      FmiInvalidNativeStateException

Throws:

InvalidParameterException

FmiInvalidNativeStateException

getBooleanStatus

FmuResult<Boolean> getBooleanStatus(Fmi2StatusKind kind)
                             throws FmuInvocationException

Throws:

FmuInvocationException

getStatus

FmuResult<Fmi2Status> getStatus(Fmi2StatusKind kind)
                         throws FmuInvocationException

Throws:

FmuInvocationException

getIntegerStatus

FmuResult<Integer> getIntegerStatus(Fmi2StatusKind kind)
                             throws FmuInvocationException

Throws:

FmuInvocationException

getRealStatus

FmuResult<Double> getRealStatus(Fmi2StatusKind kind)
                         throws FmuInvocationException

Throws:

FmuInvocationException

getStringStatus

FmuResult<String> getStringStatus(Fmi2StatusKind kind)
                           throws FmuInvocationException

Throws:

FmuInvocationException

terminate

Fmi2Status terminate()
              throws FmuInvocationException

Throws:

FmuInvocationException

freeInstance

void freeInstance()
           throws FmuInvocationException

Throws:

FmuInvocationException

getState

FmuResult<IFmiComponentState> getState()
                                throws FmuInvocationException

Throws:

FmuInvocationException

setState

Fmi2Status setState(IFmiComponentState state)
             throws FmuInvocationException

Throws:

FmuInvocationException

freeState

Fmi2Status freeState(IFmiComponentState state)
              throws FmuInvocationException

Throws:

FmuInvocationException

isValid

boolean isValid()

getMaxStepSize

FmuResult<Double> getMaxStepSize()
                          throws FmiInvalidNativeStateException

Extension method suggested in Broman et al

Returns:

result

Throws:

FmiInvalidNativeStateException - in case of error