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

Interface FmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE>

Type Parameters:

AST - the construction type. Often a kind of AST statement

PORT_SCALAR_TYPE - the port internal reference type. Often a kind of scalar variable from FMI

All Superinterfaces:

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

All Known Subinterfaces:

FmiBuilder.Fmi2ComponentVariable<AST,PORT_SCALAR_TYPE>, FmiBuilder.Fmi3InstanceVariable<AST,PORT_SCALAR_TYPE>

Enclosing interface:

FmiBuilder<AST,B,E,SETTINGS>

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

Type that represents common FMI functions accross versions for now 2 and 3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FmiBuilder.FmiSimulationInstance.PortExpressionValueMap<PORT_SCALAR_TYPE,AST>
static interface	FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST>
static interface	FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST>

Method Summary

Modifier and Type	Method	Description
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	get()	Get all (linked) port values
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	get(int... valueReferences)	get filter by value reference
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	get(String... names)	Get filter by names
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	get(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)	Get port values aka fmiGet
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	get(FmiBuilder.Scope<AST> scope, FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	getAndShare()
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	getAndShare(String... names)
<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>>	getAndShare(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)
FmiBuilder.Port<PORT_SCALAR_TYPE,AST>	getPort(int valueReference)	Get port by ref val
FmiBuilder.Port<PORT_SCALAR_TYPE,AST>	getPort(String name)	Get port by name
List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>>	getPorts()
List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>>	getPorts(int... valueReferences)	Get ports by ref val
List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>>	getPorts(String... names)	Get ports by name
<V> FmiBuilder.Variable<AST,V>	getShared(String name)
<V> FmiBuilder.Variable<AST,V>	getShared(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port)
<V> FmiBuilder.Variable<AST,V>	getSingle(String name)	Get the value of a single port
<V> FmiBuilder.Variable<AST,V>	getSingle(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port)
FmiBuilder.StateVariable<AST>	getState()	Get the current state
FmiBuilder.StateVariable<AST>	getState(FmiBuilder.Scope<AST> scope)	Get the current state
<V> void	set(FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST> value)	Set port values (if ports is not from this fmu then the links are used to remap)
<V> void	set(FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST> value)
<V> void	set(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port, FmiBuilder.Value<V> value)
<V> void	set(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port, FmiBuilder.Variable<AST,V> value)
<V> void	set(FmiBuilder.Scope<AST> scope, FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST> value)
<V> void	set(FmiBuilder.Scope<AST> scope, FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST> value)
<V> void	set(FmiBuilder.Scope<AST> scope, FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port, FmiBuilder.Variable<AST,V> value)
void	setDebugLogging(List<String> categories, boolean enableLogging)
void	setInt(Map<? extends Integer,? extends FmiBuilder.Value<Integer>> values)	Set this fmu ports by val ref
void	setLinked()
void	setLinked(long... filterValueReferences)
void	setLinked(String... filterNames)
void	setLinked(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... filterPorts)
void	setLinked(FmiBuilder.Scope<AST> scope, FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... filterPorts)	Set this fmu port by name and link
void	setString(Map<? extends String,? extends FmiBuilder.Value<String>> value)	Set this fmy ports by name
<V> void	share(Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> values)	Makes the values publicly available to all linked connections.
<V> void	share(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port, FmiBuilder.Variable<AST,V> value)	Makes the value publicly available to all linked connections.

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)

getPorts

List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>> getPorts()

getPorts

List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>> getPorts(String... names)

Get ports by name

Parameters:

names -

Returns:

getPorts

List<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>> getPorts(int... valueReferences)

Get ports by ref val

Parameters:

valueReferences -

Returns:

getPort

FmiBuilder.Port<PORT_SCALAR_TYPE,AST> getPort(String name)

Get port by name

Parameters:

name -

Returns:

getPort

FmiBuilder.Port<PORT_SCALAR_TYPE,AST> getPort(int valueReference)

Get port by ref val

Parameters:

valueReference -

Returns:

get

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> get(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)

Get port values aka fmiGet

Parameters:

ports -

Returns:

get

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> get(FmiBuilder.Scope<AST> scope,
                                                                                                                    FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)

get

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> get()

Get all (linked) port values

Returns:

get

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> get(int... valueReferences)

get filter by value reference

Parameters:

valueReferences -

Returns:

get

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> get(String... names)

Get filter by names

Parameters:

names -

Returns:

getAndShare

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> getAndShare(String... names)

getAndShare

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> getAndShare(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... ports)

getAndShare

<V> Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,V>> getAndShare()

getShared

<V> FmiBuilder.Variable<AST,V> getShared(String name)

getShared

<V> FmiBuilder.Variable<AST,V> getShared(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port)

getSingle

<V> FmiBuilder.Variable<AST,V> getSingle(String name)

Get the value of a single port

Parameters:

name -

Returns:

getSingle

<V> FmiBuilder.Variable<AST,V> getSingle(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port)

set

<V> void set(FmiBuilder.Scope<AST> scope,
             FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST> value)

set

<V> void set(FmiBuilder.Scope<AST> scope,
             FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST> value)

set

<V> void set(FmiBuilder.FmiSimulationInstance.PortValueMap<V,PORT_SCALAR_TYPE,AST> value)

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

Parameters:

value -

set

<V> void set(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port,
             FmiBuilder.Value<V> value)

set

<V> void set(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port,
             FmiBuilder.Variable<AST,V> value)

set

<V> void set(FmiBuilder.Scope<AST> scope,
             FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port,
             FmiBuilder.Variable<AST,V> value)

set

<V> void set(FmiBuilder.FmiSimulationInstance.PortVariableMap<V,PORT_SCALAR_TYPE,AST> value)

setLinked

void setLinked(FmiBuilder.Scope<AST> scope,
               FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... filterPorts)

Set this fmu port by name and link

setLinked

void setLinked()

setLinked

void setLinked(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... filterPorts)

setLinked

void setLinked(String... filterNames)

setLinked

void setLinked(long... filterValueReferences)

setInt

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

Set this fmu ports by val ref

Parameters:

values -

setString

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

Set this fmy ports by name

Parameters:

value -

share

<V> void share(Map<? extends FmiBuilder.Port<PORT_SCALAR_TYPE,AST>,? extends FmiBuilder.Variable<AST,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(FmiBuilder.Port<PORT_SCALAR_TYPE,AST> port,
               FmiBuilder.Variable<AST,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

FmiBuilder.StateVariable<AST> getState()
                                throws XPathExpressionException

Get the current state

Returns:

Throws:

XPathExpressionException

getState

FmiBuilder.StateVariable<AST> getState(FmiBuilder.Scope<AST> scope)
                                throws XPathExpressionException

Get the current state

Returns:

Throws:

XPathExpressionException