ncsa.tools.ogrescript.tasks.container.procedure
Class Call

java.lang.Object
  ncsa.tools.ogrescript.OgreScriptElement
      ncsa.tools.ogrescript.tasks.OgreScriptBaseTask
          ncsa.tools.ogrescript.tasks.OgreScriptTaskContainer
              ncsa.tools.ogrescript.tasks.container.procedure.Call

All Implemented Interfaces:

IIdentifiable, ISelfConfiguring, ITask, UserFacing

public class Call

extends OgreScriptTaskContainer

Aside from procedure name, can have attributes corresponding to the parameters defined in the procedure's formal parameter list. This container is an extender, and should map the attribute values to the list of formal parameter names on the local frame.

The same applies to return values: the call can map new variable names to the procedures formal return value names. These will be either declared on the calling frame, if no such variable previously exists, or reassigned if it does, after returning from the procedure frame.

NOTE: if the value needs to be a dynamic reference which could change during the execution of the procedure, wrap it in a literal expression; e.g., ARG_1="$L{${someReferenceOutsideLocal}}"; this will assure that it is placed on the local frame as "(param1, ${someReferenceOutsideLocal})" [this would constitute a rather rare use case].

Author:

arossi

Field Summary

static java.lang.String

TAG_SELF

Fields inherited from class ncsa.tools.ogrescript.tasks.OgreScriptBaseTask

TAG_EXT_PT, TAG_REQUIRED

Constructor Summary

Call()

Methods inherited from class ncsa.tools.ogrescript.tasks.OgreScriptTaskContainer

getWorkIncrementProvider, setWorkIncrementProvider, setWrapper

Methods inherited from class ncsa.tools.ogrescript.tasks.OgreScriptBaseTask

execute, getInstanceId, getPlugin, getScript, getTaskId, getTaskName, setEnvironment, setInstanceId, setScript, setTaskId, setTaskName, toString

Methods inherited from class ncsa.tools.ogrescript.OgreScriptElement

asElement, initializeFromElement

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ncsa.tools.ogrescript.ISelfConfiguring

setEnvironment

Methods inherited from interface ncsa.tools.common.UserFacing

asElement, initializeFromElement

Field Detail

TAG_SELF

public static final java.lang.String TAG_SELF

See Also:

Constant Field Values

Constructor Detail

Call

public Call()