SPARK Documentation

This is auto-generated documentation.

Contents:

• Actions
• Predicates
• Functions

forceSucceed $task

Make the task succeed and stop execution of any procedure instances.

getIntentions $intentions

Return a list of current intentions.

getSelfProcInst $pi

Get the procedure instance that performs this action

getSelfTask $task

Get the task of the procedure instance that performs this action

procInstPrintStack $pi

Print the spark procedure instances from the objective for $pi down to $pi itself.

CurrentEvent $task

In the precondition or body of a procedure instance, return the event that triggered the procedure instance

CurrentTFrame $pi

In the body of a procedure instance, return that procedure instance

FailValue $failure $value

Tests whether $failure was caused by a fail: action and if so, returns the value given

GetProcFromTframe $tframe $procedure

Get the procedure from its tframe

GoalInputParameters $tframe $args

Given an instance of GoalEvent it returns its input arguments.

GoalOutputParameters $tframe $args

Given an instance of GoalEvent it returns its output arguments.

IsIntended $intention

Determine whether $intention is being intended.

ModuleName $module $modname

Get the name of a module

Objective $pi_or_task $obj_task

ObjectiveAttributes $goalIntendEvent $attrs

Cache of the attributes associated with a goal - used by Ken's user interface

PredicateParameters $tframe $args

Given an instance of AddFactEvent, it returns its arguments

ProcInstBodyTaskExpr $pi $taskexpr

retrieve the body: taskexpression for a given procedure

ProcInstId $tframe $id

From procedure instance find id and vice versa

ProcInstProcName $pi $proc_name

Get name of generic procedure for procedure instance

ProcModule $procedure $module

Get the module of a procedure

ProcPackage $procedure $packageName

Get the package name of a procedure

ProcedureModule $tframe $modname

ProcedureName $tframe $name

Given a procedure tframe, it returns its name

ProcedureParentID $tframe $id

Given a procedure tframe, it returns its parent's ID

TaskContext $pi_or_task $parent_task

from a procedure instance or task, find the immediate parent task

TaskExprFirstTaskExprs $taskexpr $first_taskexprs

Find the list of initial basic taskexprs that will be executed.

TaskExprNextTaskExprs $taskexpr $next_taskexprs

For a basic taskexpr, find the list of immediate successor taskexprs that will be executed.

TaskId $task $id

From task find id and vice versa (only works for tasks that have started)

TaskIdStatement $task_id $statement_structure

TaskIdSuccessor $task_id $next_task_id

Note, must use task_id as the task may not exist yet

TaskModule $task $module

Get the module of a procedure

TaskName $task $name

Given a task, it returns its name

TaskParentID $tframe $id

Given a task tframe, it returns its parent's ID

TaskParentName $tframe $name

Given a task tframe, it returns its parent's name

taskIdForSubTask $procinstid $tasklabel

Compute the task id from a procedure instance ID and a task expression label