Instance of a trigger (port, action, or timer).
More...
Inherits org.lflang.generator.NamedInstance< T >.
|
| T | getDefinition () |
| | Return the definition, which is the AST node for this object.
|
| Set< ReactionInstance > | getDependentReactions () |
| | Return the reaction instances that are triggered or read by this trigger.
|
| Set< ReactionInstance > | getDependsOnReactions () |
| | Return the reaction instances that may send data via this port or action.
|
| 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 trigger.
|
| 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).
|
| boolean | isReset () |
| | Return true if this trigger is "startup".
|
| boolean | isShutdown () |
| | Return true if this trigger is "shutdown".
|
| boolean | isStartup () |
| | Return true if this trigger is "startup".
|
| 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 | 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.
|
|
| int | depth |
| | The depth in the hierarchy of this instance.
|
|
| T | definition |
| | The Instantiation AST object from which this was created.
|
| Set< ReactionInstance > | dependentReactions = new LinkedHashSet<>() |
| | Reaction instances that are triggered or read by this trigger.
|
| Set< ReactionInstance > | dependsOnReactions = new LinkedHashSet<>() |
| | Reaction instances that may send data via this port or action.
|
| 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.
|
Instance of a trigger (port, action, or timer).
- Author
- Marten Lohstroh
-
Edward A. Lee
-
Alexander Schulz-Rosengarten
◆ TriggerInstance()
Construct a new instance with the specified definition and parent.
E.g., for a action instance, the definition is Action, and for a port instance, it is Port. These are nodes in the AST. This is protected because only subclasses should be constructed.
- Parameters
-
| definition | The definition in the AST for this instance. |
| parent | The reactor instance that creates this instance. |
◆ builtinTrigger()
Construct a new instance for a special builtin trigger.
- Parameters
-
| trigger | The actual trigger definition. |
| parent | The reactor instance that creates this instance. |
◆ getDefinition()
Return the definition, which is the AST node for this object.
◆ getDependentReactions()
Return the reaction instances that are triggered or read by this trigger.
If this port is an output, then the reaction instances belong to the parent of the port's parent. If the port is an input, then the reaction instances belong to the port's parent.
◆ getDependsOnReactions()
Return the reaction instances that may send data via this port or action.
If this is an input port, then the reaction instance belongs to parent of the port's parent. If it is an output port, the reaction instance belongs to the port's parent. If it is an action, then the reaction belongs to the same parent as that of this action.
◆ getDepth()
Get the depth of the reactor instance.
This is 0 for the main reactor, 1 for reactors immediately contained therein, etc.
◆ 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.
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].
- Returns
- The full name of this instance.
◆ getFullNameWithJoiner()
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.
- Returns
- A string representing this instance.
◆ getMode()
Returns the directly/indirectly enclosing mode.
- Parameters
-
| direct | flag whether to check only for direct enclosing mode or also consider modes of parent reactor instances. |
- Returns
- The mode, if any, null otherwise.
◆ getName()
Return the name of this trigger.
- Returns
- The name of this trigger.
◆ getParent()
Return the parent or null if this is a top-level reactor.
◆ getWidth()
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.
◆ hasParent()
Return true if this instance has the specified parent (possibly indirectly, anywhere up the hierarchy).
◆ isReset()
Return true if this trigger is "startup".
/
◆ isShutdown()
Return true if this trigger is "shutdown".
◆ isStartup()
Return true if this trigger is "startup".
/
◆ parents()
Return a list of all the parents starting with the root().
◆ root()
Return the root reactor, which is the top-level parent.
- Returns
- The top-level parent.
◆ setWidth()
Set the width.
This method is here for testing only and should not be used for any other purpose.
- Parameters
-
◆ 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.
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 ''.
- Returns
- An identifier for this instance that is guaranteed to be unique within the top-level parent.
◆ definition
The Instantiation AST object from which this was created.
◆ dependentReactions
Reaction instances that are triggered or read by this trigger.
If this port is an output, then the reaction instances belong to the parent of the port's parent. If the port is an input, then the reaction instances belong to the port's parent.
◆ dependsOnReactions
Reaction instances that may send data via this port or action.
If this is an input port, then the reaction instance belongs to parent of the port's parent. If it is an output port, the reaction instance belongs to the port's parent. If it is an action, then the reaction belongs belongs to the same parent as this action.
◆ depth
The depth in the hierarchy of this instance.
This is 0 for main or federated, 1 for the reactors immediately contained, etc.
◆ identifierLengthLimit
A limit on the number of characters returned by uniqueID.
◆ parent
The reactor instance that creates this instance.
◆ 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.
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).
◆ width
The width of this instance.
This is 1 for everything except a PortInstance representing a multiport and a ReactorInstance representing a bank.
The documentation for this class was generated from the following file:
- /Users/runner/work/lingua-franca/lingua-franca/core/src/main/java/org/lflang/generator/TriggerInstance.java
1.15.0