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

Interface Fmi2Builder.Fmi2ComponentVariable<T>

All Superinterfaces:

Fmi2Builder.Variable<T,Fmi2Builder.NamedVariable<T>>

Enclosing interface:

Fmi2Builder<S,B,E,SETTINGS>

public static interface Fmi2Builder.Fmi2ComponentVariable<T>
extends Fmi2Builder.Variable<T,Fmi2Builder.NamedVariable<T>>

Interface for an fmi compoennt.

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

Modifier and Type	Interface	Description
static interface	Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap
static interface	Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V>
static interface	Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<S,V>

Method Summary

Modifier and Type	Method	Description
void	enterInitializationMode()
void	enterInitializationMode(Fmi2Builder.Scope<T> scope)
void	exitInitializationMode()
void	exitInitializationMode(Fmi2Builder.Scope<T> scope)
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	get()	Get all (linked) port values
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	get(int... valueReferences)	get filter by value reference
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	get(String... names)	Get filter by names
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	get(Fmi2Builder.Port... ports)	Get port values aka fmiGet
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	get(Fmi2Builder.Scope<T> scope, Fmi2Builder.Port... ports)
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	getAndShare()
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	getAndShare(String... names)
<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>>	getAndShare(Fmi2Builder.Port... ports)
Fmi2Builder.Port	getPort(int valueReference)	Get port by ref val
Fmi2Builder.Port	getPort(String name)	Get port by name
List<? extends Fmi2Builder.Port>	getPorts()
List<? extends Fmi2Builder.Port>	getPorts(int... valueReferences)	Get ports by ref val
List<? extends Fmi2Builder.Port>	getPorts(String... names)	Get ports by name
<V> Fmi2Builder.Variable<T,V>	getShared(String name)
<V> Fmi2Builder.Variable<T,V>	getShared(Fmi2Builder.Port port)
<V> Fmi2Builder.Variable<T,V>	getSingle(String name)	Get the value of a single port
<V> Fmi2Builder.Variable<T,V>	getSingle(Fmi2Builder.Port port)
Fmi2Builder.StateVariable<T>	getState()	Get the current state
Fmi2Builder.StateVariable<T>	getState(Fmi2Builder.Scope<T> scope)	Get the current state
<V> void	set(Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)	Set port values (if ports is not from this fmu then the links are used to remap)
<V> void	set(Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<T,V> value)
<V> void	set(Fmi2Builder.Port port, Fmi2Builder.Value<V> value)
<V> void	set(Fmi2Builder.Port port, Fmi2Builder.Variable<T,V> value)
<V> void	set(Fmi2Builder.Scope<T> scope, Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)
<V> void	set(Fmi2Builder.Scope<T> scope, Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<T,V> value)
<V> void	set(Fmi2Builder.Scope<T> scope, Fmi2Builder.Port port, Fmi2Builder.Variable<T,V> value)
void	setDebugLogging(List<String> categories, boolean enableLogging)
void	setInt(Map<? extends Integer,? extends Fmi2Builder.Value<Integer>> values)	Set this fmu ports by val ref
void	setLinked()
void	setLinked(long... filterValueReferences)
void	setLinked(String... filterNames)
void	setLinked(Fmi2Builder.Port... filterPorts)
void	setLinked(Fmi2Builder.Scope<T> scope, Fmi2Builder.Port... filterPorts)	Set this fmu port by name and link
void	setString(Map<? extends String,? extends Fmi2Builder.Value<String>> value)	Set this fmy ports by name
void	setupExperiment(double startTime, Double endTime, Double tolerance)
void	setupExperiment(Fmi2Builder.DoubleVariable<T> startTime, Fmi2Builder.DoubleVariable<T> endTime, Double tolerance)
void	setupExperiment(Fmi2Builder.Scope<T> scope, double startTime, Double endTime, Double tolerance)
void	setupExperiment(Fmi2Builder.Scope<T> scope, Fmi2Builder.DoubleVariable<T> startTime, Fmi2Builder.DoubleVariable<T> endTime, Double tolerance)
<V> void	share(Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> values)	Makes the values publicly available to all linked connections.
<V> void	share(Fmi2Builder.Port port, Fmi2Builder.Variable<T,V> value)	Makes the value publicly available to all linked connections.
Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>>	step(Fmi2Builder.DoubleVariable<T> currentCommunicationPoint, Fmi2Builder.DoubleVariable<T> communicationStepSize)
Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>>	step(Fmi2Builder.DoubleVariable<T> currentCommunicationPoint, Fmi2Builder.DoubleVariable<T> communicationStepSize, Fmi2Builder.BoolVariable<T> noSetFMUStatePriorToCurrentPoint)
Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>>	step(Fmi2Builder.Scope<T> scope, Fmi2Builder.DoubleVariable<T> currentCommunicationPoint, Fmi2Builder.DoubleVariable<T> communicationStepSize)
Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>>	step(Fmi2Builder.Scope<T> scope, Fmi2Builder.DoubleVariable<T> currentCommunicationPoint, Fmi2Builder.DoubleVariable<T> communicationStepSize, Fmi2Builder.BoolVariable<T> noSetFMUStatePriorToCurrentPoint)
void	terminate()
void	terminate(Fmi2Builder.Scope<T> scope)

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

getDeclaredScope, getName, setValue, setValue, setValue, setValue

Method Detail

setDebugLogging

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

setupExperiment

void setupExperiment(Fmi2Builder.DoubleVariable<T> startTime,
                     Fmi2Builder.DoubleVariable<T> endTime,
                     Double tolerance)

setupExperiment

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

enterInitializationMode

void enterInitializationMode()

exitInitializationMode

void exitInitializationMode()

setupExperiment

void setupExperiment(Fmi2Builder.Scope<T> scope,
                     Fmi2Builder.DoubleVariable<T> startTime,
                     Fmi2Builder.DoubleVariable<T> endTime,
                     Double tolerance)

setupExperiment

void setupExperiment(Fmi2Builder.Scope<T> scope,
                     double startTime,
                     Double endTime,
                     Double tolerance)

enterInitializationMode

void enterInitializationMode(Fmi2Builder.Scope<T> scope)

exitInitializationMode

void exitInitializationMode(Fmi2Builder.Scope<T> scope)

terminate

void terminate(Fmi2Builder.Scope<T> scope)

terminate

void terminate()

step

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

Parameters:

scope -

currentCommunicationPoint -

communicationStepSize -

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

Returns:

step

Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>> step(Fmi2Builder.Scope<T> scope,
                                                                                Fmi2Builder.DoubleVariable<T> currentCommunicationPoint,
                                                                                Fmi2Builder.DoubleVariable<T> communicationStepSize)

step

Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>> step(Fmi2Builder.DoubleVariable<T> currentCommunicationPoint,
                                                                                Fmi2Builder.DoubleVariable<T> communicationStepSize,
                                                                                Fmi2Builder.BoolVariable<T> noSetFMUStatePriorToCurrentPoint)

step

Map.Entry<Fmi2Builder.BoolVariable<T>,Fmi2Builder.DoubleVariable<T>> step(Fmi2Builder.DoubleVariable<T> currentCommunicationPoint,
                                                                                Fmi2Builder.DoubleVariable<T> communicationStepSize)

getPorts

List<? extends Fmi2Builder.Port> getPorts()

getPorts

List<? extends Fmi2Builder.Port> getPorts(String... names)

Get ports by name

Parameters:

names -

Returns:

getPorts

List<? extends Fmi2Builder.Port> getPorts(int... valueReferences)

Get ports by ref val

Parameters:

valueReferences -

Returns:

getPort

Fmi2Builder.Port getPort(String name)

Get port by name

Parameters:

name -

Returns:

getPort

Fmi2Builder.Port getPort(int valueReference)

Get port by ref val

Parameters:

valueReference -

Returns:

get

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> get(Fmi2Builder.Port... ports)

Get port values aka fmiGet

Parameters:

ports -

Returns:

get

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> get(Fmi2Builder.Scope<T> scope,
                                                                                        Fmi2Builder.Port... ports)

get

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> get()

Get all (linked) port values

Returns:

get

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> get(int... valueReferences)

get filter by value reference

Parameters:

valueReferences -

Returns:

get

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> get(String... names)

Get filter by names

Parameters:

names -

Returns:

getAndShare

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> getAndShare(String... names)

getAndShare

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> getAndShare(Fmi2Builder.Port... ports)

getAndShare

<V> Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> getAndShare()

getShared

<V> Fmi2Builder.Variable<T,V> getShared(String name)

getShared

<V> Fmi2Builder.Variable<T,V> getShared(Fmi2Builder.Port port)

getSingle

<V> Fmi2Builder.Variable<T,V> getSingle(String name)

Get the value of a single port

Parameters:

name -

Returns:

getSingle

<V> Fmi2Builder.Variable<T,V> getSingle(Fmi2Builder.Port port)

set

<V> void set(Fmi2Builder.Scope<T> scope,
             Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)

set

<V> void set(Fmi2Builder.Scope<T> scope,
             Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<T,V> value)

set

<V> void set(Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)

Set port values (if ports is not from this fmu then the links are used to remap)

Parameters:

value -

set

<V> void set(Fmi2Builder.Port port,
             Fmi2Builder.Value<V> value)

set

<V> void set(Fmi2Builder.Port port,
             Fmi2Builder.Variable<T,V> value)

set

<V> void set(Fmi2Builder.Scope<T> scope,
             Fmi2Builder.Port port,
             Fmi2Builder.Variable<T,V> value)

set

<V> void set(Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<T,V> value)

setLinked

void setLinked(Fmi2Builder.Scope<T> scope,
               Fmi2Builder.Port... filterPorts)

Set this fmu port by name and link

setLinked

void setLinked()

setLinked

void setLinked(Fmi2Builder.Port... filterPorts)

setLinked

void setLinked(String... filterNames)

setLinked

void setLinked(long... filterValueReferences)

setInt

void setInt(Map<? extends Integer,? extends Fmi2Builder.Value<Integer>> values)

Set this fmu ports by val ref

Parameters:

values -

setString

void setString(Map<? extends String,? extends Fmi2Builder.Value<String>> value)

Set this fmy ports by name

Parameters:

value -

share

<V> void share(Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<T,V>> values)

Makes the values publicly available to all linked connections. On next set these ports will be resolved to the values given for other fmu

Parameters:

values -

share

<V> void share(Fmi2Builder.Port port,
               Fmi2Builder.Variable<T,V> value)

Makes the value publicly available to all linked connections. On next set these ports will be resolved to the values given for other fmu

Parameters:

value -

getState

Fmi2Builder.StateVariable<T> getState()
                               throws XPathExpressionException

Get the current state

Returns:

Throws:

XPathExpressionException

getState

Fmi2Builder.StateVariable<T> getState(Fmi2Builder.Scope<T> scope)
                               throws XPathExpressionException

Get the current state

Returns:

Throws:

XPathExpressionException