GBBopen 1.5 Reference -- sole-trigger-instance-of

sole-trigger-instance-of

sole-trigger-instance-of source => trigger-instance or nil [Generic Function]

Purpose
Return the trigger unit instance of a KSA, event, or a list of KSAs or events.

Method signatures

sole-trigger-instance-of (cons cons) => trigger-instance or nil

sole-trigger-instance-of (event single-instance-event) => trigger-instance or nil

sole-trigger-instance-of (ksa ksa) => trigger-instance or nil

sole-trigger-instance-of (event multiple-instance-event) => trigger-instance or nil

sole-trigger-instance-of (event non-instance-event) => nil

Package :agenda-shell

Module :agenda-shell

Arguments and values

source		A KSA, event, or a list of KSAs or events
trigger-instance		A unit instance or `nil`

Returns
The trigger unit instance or nil, if one was not found in source

Description
Typically, sole-trigger-instance-of is called with a single KSA or single-instance event. If more than one trigger unit instance is found in source, an error is signaled.

Example
Return the (sole) trigger unit instance of a KSA:

  > (sole-trigger-instance-of ksa)
  #<hyp 419 (1835 4791) 0.85 [5..35]>
  >

The GBBopen Project

sole-trigger-instance-of