 |
lingua-franca 0.10.1
Lingua Franca code generator
|
|
lingua-franca 0.10.1
Lingua Franca code generator
|
Representation of a compile-time instance of a parameter. More...
Inherits org.lflang.generator.NamedInstance< Parameter >.
Public Member Functions | |
| Initializer | getActualValue () |
| Return the (possibly overridden) value of this parameter in the containing instance. | |
| T | getDefinition () |
| Return the definition, which is the AST node for this object. | |
| int | getDepth () |
| Get the depth of the reactor instance. | |
| String | getFullName () |
| Return the full name of this instance, which has the form "a.b.c", where "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main. | |
| String | getFullNameWithJoiner (String joiner) |
| Return a string of the form "a.b.c", where "." is replaced by the specified joiner, "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main. | |
| ModeInstance | getMode (boolean direct) |
| Returns the directly/indirectly enclosing mode. | |
| String | getName () |
| Return the name of this parameter. | |
| Assignment | getOverride () |
| Return the assignment that overrides this parameter in the parent's instantiation or null if there is no override. | |
| ReactorInstance | getParent () |
| Return the parent or null if this is a top-level reactor. | |
| int | getWidth () |
| Return the width of this instance, which in this base class is 1. | |
| boolean | hasParent (ReactorInstance container) |
| Return true if this instance has the specified parent (possibly indirectly, anywhere up the hierarchy). | |
| ParameterInstance (Parameter definition, ReactorInstance parent) | |
| Create a runtime instance from the specified definition and with the specified parent that instantiated it. | |
| List< ReactorInstance > | parents () |
| Return a list of all the parents starting with the root(). | |
| ReactorInstance | root () |
| Return the root reactor, which is the top-level parent. | |
| void | setWidth (int width) |
| Set the width. | |
| String | toString () |
| Return a descriptive string. | |
| String | uniqueID () |
| Return an identifier for this instance, which has the form "a_b_c" or "a_b_c_n", where "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main. | |
Public Attributes | |
| InferredType | type |
Static Public Attributes | |
| static int | identifierLengthLimit |
| A limit on the number of characters returned by uniqueID. | |
Protected Attributes | |
| int | depth |
| The depth in the hierarchy of this instance. | |
Package Attributes | |
| T | definition |
| The Instantiation AST object from which this was created. | |
| ReactorInstance | parent |
| The reactor instance that creates this instance. | |
| HashMap< String, Integer > | uniqueIDCount |
| Map from a name of the form a_b_c to the number of unique IDs with that prefix that have been already assigned. | |
| int | width |
| The width of this instance. | |
Representation of a compile-time instance of a parameter.
Upon creation, it is checked whether this parameter is overridden by an assignment in the instantiation that this parameter instance is a result of. If it is overridden, the parameter gets initialized using the value looked up in the instantiation hierarchy.
| org.lflang.generator.ParameterInstance.ParameterInstance | ( | Parameter | definition, |
| ReactorInstance | parent ) |
Create a runtime instance from the specified definition and with the specified parent that instantiated it.
| definition | The declaration in the AST. |
| parent | The reactor instance this parameter is a part of. |
| Initializer org.lflang.generator.ParameterInstance.getActualValue | ( | ) |
Return the (possibly overridden) value of this parameter in the containing instance.
Parameter references are resolved to actual expressions.
|
inherited |
Return the definition, which is the AST node for this object.
|
inherited |
Get the depth of the reactor instance.
This is 0 for the main reactor, 1 for reactors immediately contained therein, etc.
|
inherited |
Return the full name of this instance, which has the form "a.b.c", where "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main.
If any reactor in the hierarchy is in a bank of reactors then, it will appear as a[index]. Similarly, if c is a port in a multiport, it will appear as c[index].
|
inherited |
Return a string of the form "a.b.c", where "." is replaced by the specified joiner, "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main.
|
inherited |
Returns the directly/indirectly enclosing mode.
| direct | flag whether to check only for direct enclosing mode or also consider modes of parent reactor instances. |
| String org.lflang.generator.ParameterInstance.getName | ( | ) |
Return the name of this parameter.
| Assignment org.lflang.generator.ParameterInstance.getOverride | ( | ) |
Return the assignment that overrides this parameter in the parent's instantiation or null if there is no override.
|
inherited |
Return the parent or null if this is a top-level reactor.
|
inherited |
Return the width of this instance, which in this base class is 1.
Subclasses PortInstance and ReactorInstance change this to the multiport and bank widths respectively.
|
inherited |
Return true if this instance has the specified parent (possibly indirectly, anywhere up the hierarchy).
|
inherited |
Return a list of all the parents starting with the root().
|
inherited |
Return the root reactor, which is the top-level parent.
|
inherited |
Set the width.
This method is here for testing only and should not be used for any other purpose.
| width | The new width. |
| String org.lflang.generator.ParameterInstance.toString | ( | ) |
Return a descriptive string.
|
inherited |
Return an identifier for this instance, which has the form "a_b_c" or "a_b_c_n", where "c" is the name of this instance, "b" is the name of its container, and "a" is the name of its container, stopping at the container in main.
All names are converted to lower case. The suffix n is usually omitted, but it is possible to get name collisions using the above scheme, in which case _n will be an increasing integer until there is no collision. If the length of the root of the name as calculated above (the root is without the _n suffix) is longer than the static variable identifierLengthLimit, then the name will be truncated. The returned name will be the tail of the name calculated above with the prefix ''.
|
packageinherited |
The Instantiation AST object from which this was created.
|
protectedinherited |
The depth in the hierarchy of this instance.
This is 0 for main or federated, 1 for the reactors immediately contained, etc.
|
staticinherited |
A limit on the number of characters returned by uniqueID.
|
packageinherited |
The reactor instance that creates this instance.
| InferredType org.lflang.generator.ParameterInstance.type |
|
packageinherited |
Map from a name of the form a_b_c to the number of unique IDs with that prefix that have been already assigned.
If none have been assigned, then there is no entry in this map. This map should be non-null only for the main reactor (the top level).
|
packageinherited |
The width of this instance.
This is 1 for everything except a PortInstance representing a multiport and a ReactorInstance representing a bank.
1.15.0