Skip to content

Commit

Permalink
changed Fmi2Builder to batter represent fmi2 and 3
Browse files Browse the repository at this point in the history
  • Loading branch information
@lausdahl
lausdahl committed Oct 5, 2023
1 parent d105829 commit 4bbe9b5
Show file tree
Hide file tree
Showing 14 changed files with 925 additions and 545 deletions.
197 changes: 133 additions & 64 deletions frameworks/builder/src/main/java/org/intocps/maestro/framework/fmi2/api/Fmi2Builder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,9 +265,9 @@ interface Scope<T> extends Scoping<T> {
@Deprecated
<V> Variable<T, V> store(Value<V> tag);

Fmu2Variable<T> createFMU(String name, String loaderName, String... args) throws Exception;
<PS> Fmu2Variable<T, PS> createFMU(String name, String loaderName, String... args) throws Exception;

Fmu3Variable<T> createFMU3(String name, String loaderName, String... args) throws Exception;
<PS> Fmu3Variable<T> createFMU3(String name, String loaderName, String... args) throws Exception;

void markTransferPoint(String... names);

Expand Down Expand Up @@ -356,7 +356,21 @@ interface Numeric<A extends Number> extends Value<Number>, Type {
}


interface Port {
interface Port<T> {

/**
* Gets the fully qualified port name including its source reference. Often on the form source.name
*
* @return
*/
String getQualifiedName();

/**
* Gets the underlying objects from which the port is created
*
* @return
*/
T getSourceObject();

/**
* Get the port name
Expand All @@ -377,7 +391,7 @@ interface Port {
*
* @param receiver
*/
void linkTo(Port... receiver) throws PortLinkException;
void linkTo(Port<T>... receiver) throws PortLinkException;

/**
* Break the source link
Expand Down Expand Up @@ -485,10 +499,10 @@ interface StateVariable<T> extends Variable<T, Object> {
/**
* Handle for an fmu for the creation of component
*/
interface Fmu2Variable<S> extends Variable<S, NamedVariable<S>> {
Fmi2ComponentVariable<S> instantiate(String name, String environmentname);
interface Fmu2Variable<S, PS> extends Variable<S, NamedVariable<S>> {
Fmi2ComponentVariable<S, PS> instantiate(String name, String environmentname);

Fmi2ComponentVariable<S> instantiate(String name);
Fmi2ComponentVariable<S, PS> instantiate(String name);

// /**
// * Performs null check and frees the instance
Expand All @@ -506,12 +520,12 @@ interface Fmu2Variable<S> extends Variable<S, NamedVariable<S>> {
// throw new RuntimeException("Argument is not an FMU instance - it is not an instance of ComponentVariableFmi2API");
// }
// }
Fmi2ComponentVariable<S> instantiate(String namePrefix, TryScope<PStm> enclosingTryScope, Scope<PStm> scope, String environmentName);
Fmi2ComponentVariable<S, PS> instantiate(String namePrefix, TryScope<PStm> enclosingTryScope, Scope<PStm> scope, String environmentName);

Fmi2ComponentVariable<S> instantiate(String namePrefix, Fmi2Builder.TryScope<PStm> enclosingTryScope, Fmi2Builder.Scope<PStm> scope,
Fmi2ComponentVariable<S, PS> instantiate(String namePrefix, Fmi2Builder.TryScope<PStm> enclosingTryScope, Fmi2Builder.Scope<PStm> scope,
String environmentName, boolean loggingOn);

Fmi2ComponentVariable<S> instantiate(String name, TryScope<S> enclosingTryScope, Scope<S> scope);
Fmi2ComponentVariable<S, PS> instantiate(String name, TryScope<S> enclosingTryScope, Scope<S> scope);

//void freeInstance(Fmi2ComponentVariable<S> comp);

Expand All @@ -528,38 +542,26 @@ Fmi2ComponentVariable<S> instantiate(String namePrefix, Fmi2Builder.TryScope<PSt
interface Fmu3Variable<S> extends Variable<S, NamedVariable<S>> {


}

/**
* Generic type for all simulation instances
*
* @param <T>
*/
interface SimulationInstance<T> extends Variable<T, NamedVariable<T>> {
}

/**
* Interface for an fmi compoennt.
* <p>
* Note that all methods that do not take a scope uses the builders dynamic scope and adds the underlying instructions int he active scope.
* Type that represents common FMI functions accross versions for now 2 and 3
*
* @param <T> the construction type. Often a kind of AST statement
* @param <PS> the port internal reference type. Often a kind of scalar variable from FMI
*/
interface Fmi2ComponentVariable<T> extends Variable<T, NamedVariable<T>> {
interface FmiSimulationInstance<T, PS> extends SimulationInstance<T> {

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

void setupExperiment(DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined, Double tolerance);

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

void enterInitializationMode();

void exitInitializationMode();

void setupExperiment(Scope<T> scope, DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined,
Double tolerance);

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

void enterInitializationMode(Scope<T> scope);

void exitInitializationMode(Scope<T> scope);

void terminate(Scope<T> scope);

void terminate();

/**
* @param scope
Expand All @@ -580,82 +582,82 @@ Map.Entry<BoolVariable<T>, DoubleVariable<T>> step(DoubleVariable<T> currentComm
Map.Entry<BoolVariable<T>, DoubleVariable<T>> step(DoubleVariable<T> currentCommunicationPoint, DoubleVariable<T> communicationStepSize);


List<? extends Port> getPorts();
List<? extends Port<PS>> getPorts();

/**
* Get ports by name
*
* @param names
* @return
*/
List<? extends Port> getPorts(String... names);
List<? extends Port<PS>> getPorts(String... names);

/**
* Get ports by ref val
*
* @param valueReferences
* @return
*/
List<? extends Port> getPorts(int... valueReferences);
List<? extends Port<PS>> getPorts(int... valueReferences);

/**
* Get port by name
*
* @param name
* @return
*/
Port getPort(String name);
Port<PS> getPort(String name);

/**
* Get port by ref val
*
* @param valueReference
* @return
*/
Port getPort(int valueReference);
Port<PS> getPort(int valueReference);

/**
* Get port values aka fmiGet
*
* @param ports
* @return
*/
<V> Map<? extends Port, ? extends Variable<T, V>> get(Port... ports);
<V> Map<? extends Port<PS>, ? extends Variable<T, V>> get(Port<PS>... ports);

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

/**
* Get all (linked) port values
*
* @return
*/
<V> Map<? extends Port, ? extends Variable<T, V>> get();
<V> Map<? extends Port<PS>, ? extends Variable<T, V>> get();

/**
* get filter by value reference
*
* @param valueReferences
* @return
*/
<V> Map<? extends Port, ? extends Variable<T, V>> get(int... valueReferences);
<V> Map<? extends Port<PS>, ? extends Variable<T, V>> get(int... valueReferences);

/**
* Get filter by names
*
* @param names
* @return
*/
<V> Map<? extends Port, ? extends Variable<T, V>> get(String... names);
<V> Map<? extends Port<PS>, ? extends Variable<T, V>> get(String... names);

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

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

<V> Map<? extends Port, ? extends Variable<T, V>> getAndShare();
<V> Map<? extends Port<PS>, ? extends Variable<T, V>> getAndShare();

<V> Variable<T, V> getShared(String name);

<V> Variable<T, V> getShared(Port port);
<V> Variable<T, V> getShared(Port<PS> port);

/**
* Get the value of a single port
Expand All @@ -665,36 +667,36 @@ Map.Entry<BoolVariable<T>, DoubleVariable<T>> step(DoubleVariable<T> currentComm
*/
<V> Variable<T, V> getSingle(String name);

<V> Variable<T, V> getSingle(Port port);
<V> Variable<T, V> getSingle(Port<PS> port);

<V> void set(Scope<T> scope, PortValueMap<V> value);
<V> void set(Scope<T> scope, PortValueMap<V, PS> value);


<V> void set(Scope<T> scope, PortVariableMap<T, V> value);
<V> void set(Scope<T> scope, PortVariableMap<T, V, PS> value);

/**
* Set port values (if ports is not from this fmu then the links are used to remap)
*
* @param value
*/
<V> void set(PortValueMap<V> value);
<V> void set(PortValueMap<V, PS> value);

<V> void set(Port port, Value<V> value);
<V> void set(Port<PS> port, Value<V> value);

<V> void set(Port port, Variable<T, V> value);
<V> void set(Port<PS> port, Variable<T, V> value);

<V> void set(Scope<T> scope, Port port, Variable<T, V> value);
<V> void set(Scope<T> scope, Port<PS> port, Variable<T, V> value);

<V> void set(PortVariableMap<T, V> value);
<V> void set(PortVariableMap<T, V, PS> value);

/**
* Set this fmu port by name and link
*/
void setLinked(Scope<T> scope, Port... filterPorts);
void setLinked(Scope<T> scope, Port<PS>... filterPorts);

void setLinked();

void setLinked(Port... filterPorts);
void setLinked(Port<PS>... filterPorts);

void setLinked(String... filterNames);

Expand All @@ -720,15 +722,15 @@ Map.Entry<BoolVariable<T>, DoubleVariable<T>> step(DoubleVariable<T> currentComm
*
* @param values
*/
<V> void share(Map<? extends Port, ? extends Variable<T, V>> values);
<V> void share(Map<? extends Port<PS>, ? extends Variable<T, V>> values);

/**
* Makes the value publicly available to all linked connections. On next set these ports will be resolved to the values given for
* other fmu
*
* @param value
*/
<V> void share(Port port, Variable<T, V> value);
<V> void share(Port<PS> port, Variable<T, V> value);

/**
* Get the current state
Expand All @@ -744,17 +746,84 @@ Map.Entry<BoolVariable<T>, DoubleVariable<T>> step(DoubleVariable<T> currentComm
*/
StateVariable<T> getState(Scope<T> scope) throws XPathExpressionException;


interface PortVariableMap<S, V> extends Map<Port, Variable<S, V>> {
interface PortVariableMap<S, V, PS> extends Map<Port<PS>, Variable<S, V>> {
}

interface PortValueMap<V> extends Map<Port, Value<V>> {
interface PortValueMap<V, PS> extends Map<Port<PS>, Value<V>> {
}

interface PortExpressionValueMap extends Map<Port, ExpressionValue> {
interface PortExpressionValueMap<PS> extends Map<Port<PS>, ExpressionValue> {
}
}

/**
* Simulation instance for FMI3
*
* @param <T> building block
* @param <PS> fmi3 scalar variable type
*/
interface Fmi3InstanceVariable<T, PS> extends FmiSimulationInstance<T, PS> {


void setupExperiment(DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined, Double tolerance);

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

void enterInitializationMode(boolean toleranceDefined, double tolerance, double startTime, boolean stopTimeDefined, double stopTime);

void exitInitializationMode();

void setupExperiment(Scope<T> scope, DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined,
Double tolerance);

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

void enterInitializationMode(Scope<T> scope, boolean toleranceDefined, double tolerance, double startTime, boolean stopTimeDefined,
double stopTime);

void exitInitializationMode(Scope<T> scope);

void terminate(Scope<T> scope);

void terminate();


}

/**
* Interface for an fmi compoennt.
* <p>
* Note that all methods that do not take a scope uses the builders dynamic scope and adds the underlying instructions int he active scope.
*
* @param <T> building block
* @param <PS> fmi2 scalar variable type
*/
interface Fmi2ComponentVariable<T, PS> extends FmiSimulationInstance<T, PS> {

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

void setupExperiment(DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined, Double tolerance);

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

void enterInitializationMode();

void exitInitializationMode();

void setupExperiment(Scope<T> scope, DoubleVariable<T> startTime, DoubleVariable<T> endTime, BoolVariable<T> endTimeDefined,
Double tolerance);

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

void enterInitializationMode(Scope<T> scope);

void exitInitializationMode(Scope<T> scope);

void terminate(Scope<T> scope);

void terminate();
}

interface Variable<T, V> {
String getName();

Expand Down
Loading

0 comments on commit 4bbe9b5

Please sign in to comment.