org.lflang.generator.ActionInstance Class Reference

Instance of an action. More...

Inherits org.lflang.generator.TriggerInstance< Action >.

Public Member Functions
	ActionInstance (Action definition, ReactorInstance parent)
	Create a new action instance.
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.
TimeValue	getMinDelay ()
	Return the minimum delay for this action.
TimeValue	getMinSpacing ()
	Return the minimum spacing between action events.
String	getName ()
	Return the name of this trigger.
String	getPolicy ()
	Return the replacement policy for when minimum spacing is violated.
boolean	isPhysical ()
	Return the indicator of whether the action is physical.
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".

Static Public Attributes
static final TimeValue	DEFAULT_MIN_DELAY = TimeValue.ZERO
	The constant default for a minimum delay.

Static Package Functions
static TriggerInstance< BuiltinTriggerVariable >	builtinTrigger (BuiltinTriggerRef trigger, ReactorInstance parent)
	Construct a new instance for a special builtin trigger.

Package Attributes
Set< ReactionInstance >	dependentReactions
	Reaction instances that are triggered or read by this trigger.
Set< ReactionInstance >	dependsOnReactions
	Reaction instances that may send data via this port or action.

Detailed Description

Instance of an action.

Author

Edward A. Lee

Marten Lohstroh

Constructor & Destructor Documentation

ActionInstance()

org.lflang.generator.ActionInstance.ActionInstance	(	Action	definition,
		ReactorInstance	parent )

Create a new action instance.

If the definition is null, then this is a shutdown action.

Parameters

definition	The AST definition, or null for startup.
parent	The parent reactor.

Member Function Documentation

builtinTrigger()

TriggerInstance< BuiltinTriggerVariable > org.lflang.generator.TriggerInstance< T extends Variable >.builtinTrigger ( BuiltinTriggerRef trigger, ReactorInstance parent )

staticpackageinherited

Construct a new instance for a special builtin trigger.

Parameters

trigger	The actual trigger definition.
parent	The reactor instance that creates this instance.

getDependentReactions()

Set< ReactionInstance > org.lflang.generator.TriggerInstance< T extends Variable >.getDependentReactions ( )

inherited

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()

Set< ReactionInstance > org.lflang.generator.TriggerInstance< T extends Variable >.getDependsOnReactions ( )

inherited

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.

getMinDelay()

TimeValue org.lflang.generator.ActionInstance.getMinDelay

(

)

Return the minimum delay for this action.

getMinSpacing()

TimeValue org.lflang.generator.ActionInstance.getMinSpacing

(

)

Return the minimum spacing between action events.

getName()

String org.lflang.generator.TriggerInstance< T extends Variable >.getName ( )

inherited

Return the name of this trigger.

Returns

The name of this trigger.

getPolicy()

String org.lflang.generator.ActionInstance.getPolicy

(

)

Return the replacement policy for when minimum spacing is violated.

isPhysical()

boolean org.lflang.generator.ActionInstance.isPhysical

(

)

Return the indicator of whether the action is physical.

isReset()

boolean org.lflang.generator.TriggerInstance< T extends Variable >.isReset ( )

inherited

Return true if this trigger is "startup".

/

isShutdown()

boolean org.lflang.generator.TriggerInstance< T extends Variable >.isShutdown ( )

inherited

Return true if this trigger is "shutdown".

isStartup()

boolean org.lflang.generator.TriggerInstance< T extends Variable >.isStartup ( )

inherited

Return true if this trigger is "startup".

/

Member Data Documentation

DEFAULT_MIN_DELAY

final TimeValue org.lflang.generator.ActionInstance.DEFAULT_MIN_DELAY = TimeValue.ZERO

static

The constant default for a minimum delay.

dependentReactions

Set<ReactionInstance> org.lflang.generator.TriggerInstance< T extends Variable >.dependentReactions

packageinherited

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

Set<ReactionInstance> org.lflang.generator.TriggerInstance< T extends Variable >.dependsOnReactions

packageinherited

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.

---

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/ActionInstance.java