SoOneShot

InventorModule

genre	InventorEngines
author	Silicon Graphics Inc
package	MeVisLab/Standard
definition	inventor.def

Purpose

This engine is a timer that runs for a preset amount of time and then stops. By default, the Time In input is connected to the realTime global field. It can, however, by connected to any other time source.

The timer is started when the trigger input is touched. It then runs for the specified duration, and updates the Time Out output with the time that has elapsed. During that time, the ramp output is also updated. The ramp output starts at 0.0 at the beginning of the cycle, and linearly increases until it reaches 1.0 at the end of the cycle.

You can disable the timer by setting the disable input to TRUE. The output value remains 0.0 while the timer is disabled. If the timer is disabled in the middle of a cycle the output values will be set to 0.0.

The flags input contains control flags. Using the flags you can set the timer to be re-triggerable in the middle of a cycle, and set the output values to stay high after the cycle has been completed. By default, these flags are not set.

Windows

Default Panel

Parameter Fields

Field Index

Disable: Bool

Duration: String

Flags: String

Is Active: EngineOutput

Ramp: EngineOutput

Time In: String

Time Out: EngineOutput

Trigger: Trigger

Visible Fields

Duration

name: duration, type: String, default: 1

Duration of the active cycle.

Trigger

name: trigger, type: Trigger

Start the cycle. The trigger will be ignored if it is touched in the middle of a cycle and the RETRIGGERABLE flag is not set.

Flags

name: flags, type: String, default: ()

Control flags.

Disable

name: disable, type: Bool, default: FALSE

If TRUE, the timer is disabled.

Time In

name: timeIn, type: String, persistent: no

Running time.

Time Out

name: timeOut, type: EngineOutput, persistent: no

Elapsed time from the start.

Is Active

name: isActive, type: EngineOutput, persistent: no

Is TRUE during the active cycle.

Ramp

name: ramp, type: EngineOutput, persistent: no

Ramps linearly from 0.0 to 1.0.