SoOneShot

InventorModule

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

Purpose

The engine SoOneShot is a timer that operates for a preset duration and then stops. By default, the Time In input is connected to the realTime global field; however, it can be connected to any other time source.

The timer starts when the Trigger input is touched. It runs for the specified duration and updates the Time Out output with the elapsed time. During this period, the Ramp output is also updated, starting at 0.0 at the beginning of the cycle and linearly increasing until it reaches 1.0 at the end.

The timer can be disabled by setting the Disable input to TRUE. While the timer is disabled, the output value remains 0.0. If the timer is disabled during a cycle, the output values will be set to 0.0.

The Flags input contains control flags that allow for configuring the timer. Using these flags, the timer can be set to be re-triggerable in the middle of a cycle and to maintain high output values after the cycle has 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

Sets the duration of the active cycle.

Trigger

name: trigger, type: Trigger

When pressed, the cycle starts.

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

Sets the control flags.

The only possible flag values are RETRIGGERABLE and HOLD_FINAL.

Disable

name: disable, type: Bool, default: FALSE

If checked, the timer is disabled.

Time In

name: timeIn, type: String, persistent: no

Shows the running time.

Time Out

name: timeOut, type: EngineOutput, persistent: no

Outputs the elapsed time from the start.

This field must be connected to an appropriate Open Inventor field to access or view its value.

Is Active

name: isActive, type: EngineOutput, persistent: no

Outputs whether the timer is active.

This field must be connected to an appropriate Open Inventor field to access or view its value.

Ramp

name: ramp, type: EngineOutput, persistent: no

Outputs the linear ramp from 0.0 to 1.0.

This field must be connected to an appropriate Open Inventor field to access or view its value.