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

Interface IMablScope

All Superinterfaces:

Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>, Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

All Known Implementing Classes:

DynamicActiveBuilderScope, ScopeFmi2Api, WhileMaBLScope

public interface IMablScope
extends Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Method Summary

Modifier and Type	Method	Description
IMablScope	activate()
void	add(org.intocps.maestro.ast.node.PStm... commands)
void	addAfter(org.intocps.maestro.ast.node.PStm item, org.intocps.maestro.ast.node.PStm... commands)
void	addAll(java.util.Collection<org.intocps.maestro.ast.node.PStm> commands)
void	addBefore(org.intocps.maestro.ast.node.PStm item, org.intocps.maestro.ast.node.PStm... commands)
<Var extends VariableFmi2Api> Var	copy(java.lang.String name, Var variable)
FmuVariableFmi2Api	createFMU(java.lang.String name, java.lang.String loaderName, java.lang.String... args)
FmuVariableFmi2Api	createFMU(java.lang.String name, org.intocps.maestro.fmi.ModelDescription modelDescription, java.net.URI path)
IfMaBlScope	enterIf(Fmi2Builder.Predicate predicate)
IMablScope	enterScope()
WhileMaBLScope	enterWhile(Fmi2Builder.Predicate predicate)
java.util.Set<ComponentVariableFmi2Api>	getAllComponentFmi2Variables()	Retrieves a set of allComponentFmi2Variables including those of parents
IntVariableFmi2Api	getFmiStatusVariable()
java.lang.String	getName(java.lang.String prefix)
ScopeFmi2Api	leave()
IMablScope	parallel()
void	registerComponentVariableFmi2Api(ComponentVariableFmi2Api componentVariableFmi2Api)	This is used to maintain a register of stored ComponentVariableFmi2API, such that they can be freed in case of an error.
BooleanVariableFmi2Api	store(boolean value)
DoubleVariableFmi2Api	store(double value)	Store a given value
IntVariableFmi2Api	store(int value)
StringVariableFmi2Api	store(java.lang.String value)
BooleanVariableFmi2Api	store(java.lang.String name, boolean value)
DoubleVariableFmi2Api	store(java.lang.String name, double value)	Store a given value with a prefix name
IntVariableFmi2Api	store(java.lang.String name, int value)
StringVariableFmi2Api	store(java.lang.String name, java.lang.String value)
IntVariableFmi2Api	store(java.lang.String stabilisation_loop, IntVariableFmi2Api stabilisation_loop_max_iterations)
<V> ArrayVariableFmi2Api<V>	store(java.lang.String name, V[] value)
<V> Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V>	store(Fmi2Builder.Value<V> tag)	Store the given value and get a tag for it.

Method Detail

getFmiStatusVariable

IntVariableFmi2Api getFmiStatusVariable()

getName

java.lang.String getName(java.lang.String prefix)

enterScope

IMablScope enterScope()

Specified by:

enterScope in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

store

BooleanVariableFmi2Api store(boolean value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

enterWhile

WhileMaBLScope enterWhile(Fmi2Builder.Predicate predicate)

Specified by:

enterWhile in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

enterIf

IfMaBlScope enterIf(Fmi2Builder.Predicate predicate)

Specified by:

enterIf in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

parallel

IMablScope parallel()

Specified by:

parallel in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

leave

ScopeFmi2Api leave()

Specified by:

leave in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

add

void add(org.intocps.maestro.ast.node.PStm... commands)

Specified by:

add in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

addAll

void addAll(java.util.Collection<org.intocps.maestro.ast.node.PStm> commands)

Specified by:

addAll in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

addBefore

void addBefore(org.intocps.maestro.ast.node.PStm item,
               org.intocps.maestro.ast.node.PStm... commands)

Specified by:

addBefore in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

addAfter

void addAfter(org.intocps.maestro.ast.node.PStm item,
              org.intocps.maestro.ast.node.PStm... commands)

Specified by:

addAfter in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

activate

IMablScope activate()

Specified by:

activate in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Specified by:

activate in interface Fmi2Builder.Scoping<org.intocps.maestro.ast.node.PStm>

store

DoubleVariableFmi2Api store(double value)

Description copied from interface: Fmi2Builder.Scope

Store a given value

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Returns:

store

IntVariableFmi2Api store(int value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

StringVariableFmi2Api store(java.lang.String value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

DoubleVariableFmi2Api store(java.lang.String name,
                            double value)

Description copied from interface: Fmi2Builder.Scope

Store a given value with a prefix name

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Returns:

store

BooleanVariableFmi2Api store(java.lang.String name,
                             boolean value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

IntVariableFmi2Api store(java.lang.String name,
                         int value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

StringVariableFmi2Api store(java.lang.String name,
                            java.lang.String value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

<V> ArrayVariableFmi2Api<V> store(java.lang.String name,
                                  V[] value)

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

store

<V> Fmi2Builder.Variable<org.intocps.maestro.ast.node.PStm,V> store(Fmi2Builder.Value<V> tag)

Description copied from interface: Fmi2Builder.Scope

Store the given value and get a tag for it. Copy

Specified by:

store in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Returns:

store

IntVariableFmi2Api store(java.lang.String stabilisation_loop,
                         IntVariableFmi2Api stabilisation_loop_max_iterations)

createFMU

FmuVariableFmi2Api createFMU(java.lang.String name,
                             org.intocps.maestro.fmi.ModelDescription modelDescription,
                             java.net.URI path)
                      throws java.lang.Exception

Throws:

java.lang.Exception

createFMU

FmuVariableFmi2Api createFMU(java.lang.String name,
                             java.lang.String loaderName,
                             java.lang.String... args)
                      throws java.lang.Exception

Specified by:

createFMU in interface Fmi2Builder.Scope<org.intocps.maestro.ast.node.PStm>

Throws:

java.lang.Exception

copy

<Var extends VariableFmi2Api> Var copy(java.lang.String name,
                                       Var variable)

getAllComponentFmi2Variables

java.util.Set<ComponentVariableFmi2Api> getAllComponentFmi2Variables()

Retrieves a set of allComponentFmi2Variables including those of parents

Returns:

registerComponentVariableFmi2Api

void registerComponentVariableFmi2Api(ComponentVariableFmi2Api componentVariableFmi2Api)

This is used to maintain a register of stored ComponentVariableFmi2API, such that they can be freed in case of an error.