Package org.intocps.maestro.framework.fmi2.api

Interface FmiBuilder.Fmi2ComponentVariable<AST,PORT_SCALAR_TYPE>

Type Parameters:

AST - building block

PORT_SCALAR_TYPE - fmi2 scalar variable type

All Superinterfaces:

FmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE>, FmiBuilder.ProvidesTypedReferenceExp, FmiBuilder.SimulationInstance<AST>, FmiBuilder.Variable<AST,FmiBuilder.NamedVariable<AST>>

Enclosing interface:

FmiBuilder<AST,B,E,SETTINGS>

public static interface FmiBuilder.Fmi2ComponentVariable<AST,PORT_SCALAR_TYPE>
extends FmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE>

Interface for an fmi component.

Note that all methods that do not take a scope uses the builders dynamic scope and adds the underlying instructions int he active scope.

Nested Class Summary

Nested classes/interfaces inherited from interface org.intocps.maestro.framework.fmi2.api.FmiBuilder.FmiSimulationInstance

FmiBuilder.FmiSimulationInstance.PortExpressionValueMap<PORT_SCALAR_TYPE,AST>, FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST>, FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST>

Method Summary

Modifier and Type	Method	Description
void	enterInitializationMode()
void	enterInitializationMode(FmiBuilder.Scope<AST> scope)
void	exitInitializationMode()
void	exitInitializationMode(FmiBuilder.Scope<AST> scope)
void	setDebugLogging(List<String> categories, boolean enableLogging)
void	setupExperiment(double startTime, Double endTime, Double tolerance)
void	setupExperiment(FmiBuilder.DoubleVariable<AST> startTime, FmiBuilder.DoubleVariable<AST> endTime, FmiBuilder.BoolVariable<AST> endTimeDefined, Double tolerance)
void	setupExperiment(FmiBuilder.Scope<AST> scope, double startTime, Double endTime, Double tolerance)
void	setupExperiment(FmiBuilder.Scope<AST> scope, FmiBuilder.DoubleVariable<AST> startTime, FmiBuilder.DoubleVariable<AST> endTime, FmiBuilder.BoolVariable<AST> endTimeDefined, Double tolerance)
Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>>	step(FmiBuilder.DoubleVariable<AST> currentCommunicationPoint, FmiBuilder.DoubleVariable<AST> communicationStepSize)
Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>>	step(FmiBuilder.DoubleVariable<AST> currentCommunicationPoint, FmiBuilder.DoubleVariable<AST> communicationStepSize, FmiBuilder.BoolVariable<AST> noSetFMUStatePriorToCurrentPoint)
Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>>	step(FmiBuilder.Scope<AST> scope, FmiBuilder.DoubleVariable<AST> currentCommunicationPoint, FmiBuilder.DoubleVariable<AST> communicationStepSize)
Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>>	step(FmiBuilder.Scope<AST> scope, FmiBuilder.DoubleVariable<AST> currentCommunicationPoint, FmiBuilder.DoubleVariable<AST> communicationStepSize, FmiBuilder.BoolVariable<AST> noSetFMUStatePriorToCurrentPoint)
void	terminate()
void	terminate(FmiBuilder.Scope<AST> scope)

Methods inherited from interface org.intocps.maestro.framework.fmi2.api.FmiBuilder.FmiSimulationInstance

get, get, get, get, get, getAndShare, getAndShare, getAndShare, getPort, getPort, getPorts, getPorts, getPorts, getShared, getShared, getSingle, getSingle, getState, getState, set, set, set, set, set, set, set, setInt, setLinked, setLinked, setLinked, setLinked, setLinked, setString, share, share

Methods inherited from interface org.intocps.maestro.framework.fmi2.api.FmiBuilder.ProvidesTypedReferenceExp

getExp, getType

Methods inherited from interface org.intocps.maestro.framework.fmi2.api.FmiBuilder.Variable

getDeclaredScope, getName, setValue, setValue, setValue, setValue

Method Detail

setDebugLogging

void setDebugLogging(List<String> categories,
                     boolean enableLogging)

Specified by:

setDebugLogging in interface FmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE>

setupExperiment

void setupExperiment(FmiBuilder.DoubleVariable<AST> startTime,
                     FmiBuilder.DoubleVariable<AST> endTime,
                     FmiBuilder.BoolVariable<AST> endTimeDefined,
                     Double tolerance)

setupExperiment

void setupExperiment(double startTime,
                     Double endTime,
                     Double tolerance)

enterInitializationMode

void enterInitializationMode()

exitInitializationMode

void exitInitializationMode()

setupExperiment

void setupExperiment(FmiBuilder.Scope<AST> scope,
                     FmiBuilder.DoubleVariable<AST> startTime,
                     FmiBuilder.DoubleVariable<AST> endTime,
                     FmiBuilder.BoolVariable<AST> endTimeDefined,
                     Double tolerance)

setupExperiment

void setupExperiment(FmiBuilder.Scope<AST> scope,
                     double startTime,
                     Double endTime,
                     Double tolerance)

enterInitializationMode

void enterInitializationMode(FmiBuilder.Scope<AST> scope)

exitInitializationMode

void exitInitializationMode(FmiBuilder.Scope<AST> scope)

terminate

void terminate(FmiBuilder.Scope<AST> scope)

terminate

void terminate()

step

Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>> step(FmiBuilder.Scope<AST> scope,
                                                                                  FmiBuilder.DoubleVariable<AST> currentCommunicationPoint,
                                                                                  FmiBuilder.DoubleVariable<AST> communicationStepSize,
                                                                                  FmiBuilder.BoolVariable<AST> noSetFMUStatePriorToCurrentPoint)

Parameters:

scope -

currentCommunicationPoint -

communicationStepSize -

noSetFMUStatePriorToCurrentPoint - a pair representing (full step completed, current time after step)

Returns:

step

Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>> step(FmiBuilder.Scope<AST> scope,
                                                                                  FmiBuilder.DoubleVariable<AST> currentCommunicationPoint,
                                                                                  FmiBuilder.DoubleVariable<AST> communicationStepSize)

step

Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>> step(FmiBuilder.DoubleVariable<AST> currentCommunicationPoint,
                                                                                  FmiBuilder.DoubleVariable<AST> communicationStepSize,
                                                                                  FmiBuilder.BoolVariable<AST> noSetFMUStatePriorToCurrentPoint)

step

Map.Entry<FmiBuilder.BoolVariable<AST>,FmiBuilder.DoubleVariable<AST>> step(FmiBuilder.DoubleVariable<AST> currentCommunicationPoint,
                                                                                  FmiBuilder.DoubleVariable<AST> communicationStepSize)