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

Class ComponentVariableFmi2Api

java.lang.Object

org.intocps.maestro.framework.fmi2.api.mabl.variables.VariableFmi2Api<Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>

org.intocps.maestro.framework.fmi2.api.mabl.variables.ComponentVariableFmi2Api

All Implemented Interfaces:

Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>, Fmi2Builder.ProvidesTypedReferenceExp, Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>, IndexedVariableFmi2Api<Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>

public class ComponentVariableFmi2Api
extends VariableFmi2Api<Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>
implements Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentVariableFmi2Api.FmiFunctionType

Nested classes/interfaces inherited from interface org.intocps.maestro.framework.fmi2.api.Fmi2Builder.Fmi2ComponentVariable

Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap, Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V>, Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<S,V>

Field Summary

Fields inherited from class org.intocps.maestro.framework.fmi2.api.mabl.variables.VariableFmi2Api

dynamicScope, type

Constructor Summary

Constructors

Constructor	Description
ComponentVariableFmi2Api(org.intocps.maestro.ast.node.PStm declaration, FmuVariableFmi2Api parent, java.lang.String name, ModelDescriptionContext modelDescriptionContext, MablApiBuilder builder, IMablScope declaringScope, org.intocps.maestro.ast.node.PStateDesignator designator, org.intocps.maestro.ast.node.PExp referenceExp)

Method Summary

Modifier and Type	Method	Description
void	enterInitializationMode()
void	enterInitializationMode(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)
void	exitInitializationMode()
void	exitInitializationMode(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	get()	Get all (linked) port values
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	get(int... valueReferences)	get filter by value reference
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	get(java.lang.String... names)	Get filter by names
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	get(Fmi2Builder.Port... ports)	Get port values aka fmiGet
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	get(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Port... ports)
java.util.List<PortFmi2Api>	getAllConnectedOutputs()
<V> java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>>	getAndShare()
<V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>>	getAndShare(java.lang.String... names)	Stores the final value in rootScope Uses the rootScope for valueReferences
<V> java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>>	getAndShare(Fmi2Builder.Port... ports)
java.util.Map<PortFmi2Api,java.util.List<VariableFmi2Api<java.lang.Object>>>	getDerivatives(java.util.List<PortFmi2Api> ports, Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)
org.intocps.maestro.fmi.ModelDescription	getModelDescription()
java.lang.String	getName()
FmuVariableFmi2Api	getOwner()
PortFmi2Api	getPort(int valueReference)	Get port by ref val
PortFmi2Api	getPort(java.lang.String name)	Get port by name
java.util.List<PortFmi2Api>	getPorts()
java.util.List<PortFmi2Api>	getPorts(int... valueReferences)	Get ports by ref val
java.util.List<PortFmi2Api>	getPorts(java.lang.String... names)	Get ports by name
VariableFmi2Api	getShared(java.lang.String name)
VariableFmi2Api	getShared(Fmi2Builder.Port port)
VariableFmi2Api	getSingle(java.lang.String name)	Get the value of a single port
<V> VariableFmi2Api<V>	getSingle(Fmi2Builder.Port port)
Fmi2Builder.StateVariable<org.intocps.maestro.ast.node.PStm>	getState()	Get the current state
Fmi2Builder.StateVariable<org.intocps.maestro.ast.node.PStm>	getState(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)	Get the current state
java.util.List<PortFmi2Api>	getVariablesToLog()
void	set(Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap value)
<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<org.intocps.maestro.ast.node.PStm,V> value)
void	set(Fmi2Builder.Port p, Fmi2Builder.ExpressionValue v)
void	set(Fmi2Builder.Port port, Fmi2Builder.Value value)
<V> void	set(Fmi2Builder.Port port, VariableFmi2Api<V> value)
void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, java.util.List<PortFmi2Api> selectedPorts, java.util.function.Function<PortFmi2Api,java.util.Map.Entry<org.intocps.maestro.ast.node.PExp,org.intocps.maestro.ast.node.PType>> portToValue)
void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap value)
<V> void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)
<V> void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<org.intocps.maestro.ast.node.PStm,V> value)
void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Port p, Fmi2Builder.ExpressionValue v)
<V> void	set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Port port, VariableFmi2Api<V> value)
void	setDerivatives(ArrayVariableFmi2Api derValInBuf, ArrayVariableFmi2Api derOrderInBuf, ArrayVariableFmi2Api derRefInBuf, Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)	If two derivative ports 'Out1' (linked to 'In1') and 'Out2' (linked to 'In2') with a max derivative order of 2 and 1 then derValInBuf = [der(Out1), der(der(Out1)), der(Out2))], derOrderInBuf = [1,2,1], derRefInBuf = [In1, In1, In2]
void	setInt(java.util.Map<? extends java.lang.Integer,? extends Fmi2Builder.Value<java.lang.Integer>> values)	Set this fmu ports by val ref
void	setLinked()
void	setLinked(long... filterValueReferences)
void	setLinked(java.lang.String... filterNames)
void	setLinked(Fmi2Builder.Port... filterPorts)
void	setLinked(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.Port... filterPorts)	Set this fmu port by name and link
void	setString(java.util.Map<? extends java.lang.String,? extends Fmi2Builder.Value<java.lang.String>> value)	Set this fmy ports by name
void	setupExperiment(double startTime, java.lang.Double endTime, java.lang.Double tolerance)
void	setupExperiment(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> startTime, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> endTime, java.lang.Double tolerance)
void	setupExperiment(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, double startTime, java.lang.Double endTime, java.lang.Double tolerance)
void	setupExperiment(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> startTime, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> endTime, java.lang.Double tolerance)
void	setVariablesToLog(java.util.List<org.intocps.maestro.framework.fmi2.RelationVariable> variablesToLog)
<V> void	share(java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>> values)	Makes the values publicly available to all linked connections.
<V> void	share(Fmi2Builder.Port port, Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V> value)	Makes the value publicly available to all linked connections.
java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>>	step(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize)
java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>>	step(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize, Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm> noSetFMUStatePriorToCurrentPoint)
java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>>	step(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize)
java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>>	step(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint, Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize, Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm> noSetFMUStatePriorToCurrentPoint)
void	terminate()
void	terminate(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

Methods inherited from class org.intocps.maestro.framework.fmi2.api.mabl.variables.VariableFmi2Api

clone, getDeclaredScope, getDeclaringStm, getDesignator, getDesignatorClone, getExp, getReferenceExp, getType, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toMath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDeclaredScope, setValue, setValue, setValue, setValue

Constructor Detail

ComponentVariableFmi2Api

public ComponentVariableFmi2Api(org.intocps.maestro.ast.node.PStm declaration,
                                FmuVariableFmi2Api parent,
                                java.lang.String name,
                                ModelDescriptionContext modelDescriptionContext,
                                MablApiBuilder builder,
                                IMablScope declaringScope,
                                org.intocps.maestro.ast.node.PStateDesignator designator,
                                org.intocps.maestro.ast.node.PExp referenceExp)

Method Detail

getModelDescription

public org.intocps.maestro.fmi.ModelDescription getModelDescription()

getVariablesToLog

public java.util.List<PortFmi2Api> getVariablesToLog()

setVariablesToLog

public void setVariablesToLog(java.util.List<org.intocps.maestro.framework.fmi2.RelationVariable> variablesToLog)

share

public <V> void share(Fmi2Builder.Port port,
                      Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V> value)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

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

Specified by:

share in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setupExperiment

public void setupExperiment(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> startTime,
                            Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> endTime,
                            java.lang.Double tolerance)

Specified by:

setupExperiment in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setupExperiment

public void setupExperiment(double startTime,
                            java.lang.Double endTime,
                            java.lang.Double tolerance)

Specified by:

setupExperiment in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

enterInitializationMode

public void enterInitializationMode()

Specified by:

enterInitializationMode in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

exitInitializationMode

public void exitInitializationMode()

Specified by:

exitInitializationMode in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setupExperiment

public void setupExperiment(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                            Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> startTime,
                            Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> endTime,
                            java.lang.Double tolerance)

Specified by:

setupExperiment in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setupExperiment

public void setupExperiment(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                            double startTime,
                            java.lang.Double endTime,
                            java.lang.Double tolerance)

Specified by:

setupExperiment in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

enterInitializationMode

public void enterInitializationMode(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

Specified by:

enterInitializationMode in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

exitInitializationMode

public void exitInitializationMode(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

Specified by:

exitInitializationMode in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

step

public java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>> step(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize,
                                                                                                                                                                 Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm> noSetFMUStatePriorToCurrentPoint)

Specified by:

step in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

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

Returns:

step

public java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>> step(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize)

Specified by:

step in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

step

public java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>> step(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize,
                                                                                                                                                                 Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm> noSetFMUStatePriorToCurrentPoint)

Specified by:

step in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

step

public java.util.Map.Entry<Fmi2Builder.BoolVariable<org.intocps.maestro.ast.node.PStm>,Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm>> step(Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> currentCommunicationPoint,
                                                                                                                                                                 Fmi2Builder.DoubleVariable<org.intocps.maestro.ast.node.PStm> communicationStepSize)

Specified by:

step in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getPorts

public java.util.List<PortFmi2Api> getPorts()

Specified by:

getPorts in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getPorts

public java.util.List<PortFmi2Api> getPorts(java.lang.String... names)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get ports by name

Specified by:

getPorts in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

getPorts

public java.util.List<PortFmi2Api> getPorts(int... valueReferences)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get ports by ref val

Specified by:

getPorts in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

getPort

public PortFmi2Api getPort(java.lang.String name)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get port by name

Specified by:

getPort in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

getPort

public PortFmi2Api getPort(int valueReference)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get port by ref val

Specified by:

getPort in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

get

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> get(Fmi2Builder.Port... ports)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get port values aka fmiGet

Specified by:

get in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

get

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> get(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                                                                   Fmi2Builder.Port... ports)

Specified by:

get in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getDerivatives

public java.util.Map<PortFmi2Api,java.util.List<VariableFmi2Api<java.lang.Object>>> getDerivatives(java.util.List<PortFmi2Api> ports,
                                                                                                         Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

Parameters:

ports - The ports for which derivatives should be retrieved

scope - The builder scope.

Returns:

Derivative ports with a list of derivative values up to max derivative order

get

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> get()

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get all (linked) port values

Specified by:

get in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

get

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> get(int... valueReferences)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

get filter by value reference

Specified by:

get in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

get

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> get(java.lang.String... names)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get filter by names

Specified by:

get in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

getAndShare

public <V> java.util.Map<PortFmi2Api,VariableFmi2Api<V>> getAndShare(java.lang.String... names)

Stores the final value in rootScope Uses the rootScope for valueReferences

Specified by:

getAndShare in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getAndShare

public <V> java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>> getAndShare(Fmi2Builder.Port... ports)

Specified by:

getAndShare in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getAndShare

public <V> java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>> getAndShare()

Specified by:

getAndShare in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getShared

public VariableFmi2Api getShared(java.lang.String name)

Specified by:

getShared in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getShared

public VariableFmi2Api getShared(Fmi2Builder.Port port)

Specified by:

getShared in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getSingle

public <V> VariableFmi2Api<V> getSingle(Fmi2Builder.Port port)

Specified by:

getSingle in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getSingle

public VariableFmi2Api getSingle(java.lang.String name)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get the value of a single port

Specified by:

getSingle in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

set

public void set(Fmi2Builder.Port p,
                Fmi2Builder.ExpressionValue v)

set

public void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                Fmi2Builder.Port p,
                Fmi2Builder.ExpressionValue v)

set

public void set(Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap value)

set

public void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                Fmi2Builder.Fmi2ComponentVariable.PortExpressionValueMap value)

set

public <V> void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                    Fmi2Builder.Fmi2ComponentVariable.PortValueMap<V> value)

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

public <V> void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                    Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<org.intocps.maestro.ast.node.PStm,V> value)

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

public void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                java.util.List<PortFmi2Api> selectedPorts,
                java.util.function.Function<PortFmi2Api,java.util.Map.Entry<org.intocps.maestro.ast.node.PExp,org.intocps.maestro.ast.node.PType>> portToValue)

setDerivatives

public void setDerivatives(ArrayVariableFmi2Api derValInBuf,
                           ArrayVariableFmi2Api derOrderInBuf,
                           ArrayVariableFmi2Api derRefInBuf,
                           Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

If two derivative ports 'Out1' (linked to 'In1') and 'Out2' (linked to 'In2') with a max derivative order of 2 and 1 then derValInBuf = [der(Out1), der(der(Out1)), der(Out2))], derOrderInBuf = [1,2,1], derRefInBuf = [In1, In1, In2]

Parameters:

derValInBuf - derivative values

derOrderInBuf - derivative value orders

derRefInBuf - ports for which to set the derivative

scope - the builder scope

set

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

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

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

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

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

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

public <V> void set(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                    Fmi2Builder.Port port,
                    VariableFmi2Api<V> value)

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

public void set(Fmi2Builder.Port port,
                Fmi2Builder.Value value)

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

set

public <V> void set(Fmi2Builder.Fmi2ComponentVariable.PortVariableMap<org.intocps.maestro.ast.node.PStm,V> value)

Specified by:

set in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setLinked

public void setLinked(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope,
                      Fmi2Builder.Port... filterPorts)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Set this fmu port by name and link

Specified by:

setLinked in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setLinked

public void setLinked()

Specified by:

setLinked in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setLinked

public void setLinked(Fmi2Builder.Port... filterPorts)

Specified by:

setLinked in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setLinked

public void setLinked(java.lang.String... filterNames)

Specified by:

setLinked in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setLinked

public void setLinked(long... filterValueReferences)

Specified by:

setLinked in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setInt

public void setInt(java.util.Map<? extends java.lang.Integer,? extends Fmi2Builder.Value<java.lang.Integer>> values)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Set this fmu ports by val ref

Specified by:

setInt in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

setString

public void setString(java.util.Map<? extends java.lang.String,? extends Fmi2Builder.Value<java.lang.String>> value)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Set this fmy ports by name

Specified by:

setString in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

terminate

public void terminate()

Specified by:

terminate in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

terminate

public void terminate(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)

Specified by:

terminate in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

share

public <V> void share(java.util.Map<? extends Fmi2Builder.Port,? extends Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>> values)

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

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

Specified by:

share in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

getState

public Fmi2Builder.StateVariable<org.intocps.maestro.ast.node.PStm> getState()
                                                                      throws javax.xml.xpath.XPathExpressionException

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get the current state

Specified by:

getState in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

Throws:

javax.xml.xpath.XPathExpressionException

getState

public Fmi2Builder.StateVariable<org.intocps.maestro.ast.node.PStm> getState(Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm> scope)
                                                                      throws javax.xml.xpath.XPathExpressionException

Description copied from interface: Fmi2Builder.Fmi2ComponentVariable

Get the current state

Specified by:

getState in interface Fmi2Builder.Fmi2ComponentVariable<org.intocps.maestro.ast.node.PStm>

Returns:

Throws:

javax.xml.xpath.XPathExpressionException

getOwner

public FmuVariableFmi2Api getOwner()

getAllConnectedOutputs

public java.util.List<PortFmi2Api> getAllConnectedOutputs()

getName

public java.lang.String getName()

Specified by:

getName in interface Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>

Overrides:

getName in class VariableFmi2Api<Fmi2Builder.NamedVariable<org.intocps.maestro.ast.node.PStm>>