org.lflang.generator.TimerInstance Class Reference

Instance of a timer. More...

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

Public Member Functions
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.
String	getName ()
	Return the name of this trigger.
TimeValue	getOffset ()
	Get the value of the offset parameter.
TimeValue	getPeriod ()
	Get the value of the offset parameter.
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".
	TimerInstance (Timer definition, ReactorInstance parent)
	Create a new timer instance.

Static Public Attributes
static final TimeValue	DEFAULT_OFFSET = TimeValue.ZERO
	The global default for offset.
static final TimeValue	DEFAULT_PERIOD = TimeValue.ZERO
	The global default for period.

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 a timer.

Author

Marten Lohstroh

Edward A. Lee

Constructor & Destructor Documentation

TimerInstance()

org.lflang.generator.TimerInstance.TimerInstance	(	Timer	definition,
		ReactorInstance	parent )

Create a new timer instance.

If the definition is null, then this is a startup timer.

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.

getName()

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

inherited

Return the name of this trigger.

Returns

The name of this trigger.

getOffset()

TimeValue org.lflang.generator.TimerInstance.getOffset

(

)

Get the value of the offset parameter.

getPeriod()

TimeValue org.lflang.generator.TimerInstance.getPeriod

(

)

Get the value of the offset parameter.

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_OFFSET

final TimeValue org.lflang.generator.TimerInstance.DEFAULT_OFFSET = TimeValue.ZERO

static

The global default for offset.

DEFAULT_PERIOD

final TimeValue org.lflang.generator.TimerInstance.DEFAULT_PERIOD = TimeValue.ZERO

static

The global default for period.

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