|
JACK 5.4 Application Interface | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaos.jack.jak.plan.Plan
Plan is base class for JACK plans.
Constructor Summary | |
Plan()
|
Method Summary | |
Cursor |
after(double time)
Creates a Cursor that becomes true at a given time. |
Cursor |
after(double time,
Timer tm)
Creates a Cursor that becomes true at a given time, according to the 'tm' Timer. |
Cursor |
afterMillis(long time)
Creates a Cursor that becomes true at a given time. |
Cursor |
afterMillis(long time,
Timer tm)
Creates a Cursor that becomes true at a given time according to the 'tm' Timer. |
abstract aos.jack.jak.plan.PlanFSM |
body()
Overridden by code generated by the JACK compiler. |
Cursor |
context()
Default context method for plans that define no context method of their own. |
java.lang.String |
describe()
Method called to describe a plan and can be used for printing error messages. |
Cursor |
elapsed(double time)
Creates a Cursor that becomes true when some time has elapsed. |
Cursor |
elapsed(double time,
Timer tm)
Creates a Cursor that becomes true when some time has elapsed according to the given Timer. |
Cursor |
elapsedMillis(long time)
Creates a Cursor that becomes true when some time has elapsed. |
Cursor |
elapsedMillis(long time,
Timer tm)
Creates a Cursor that becomes true when some time has elapsed. |
aos.jack.jak.plan.PlanFSM |
fail()
Default fail() method for plans that declare no fail method of their own. |
Agent |
getAgent()
Used to access the agent in which the plan is running. |
PlanInstanceInfo |
getInstanceInfo()
Used to retrieve information about the instance of the plan |
aos.jack.jak.rvt.MonitorID |
getMonitor()
|
java.lang.String |
getPlanName()
Gets the name of the Plan , as a fully qualified
Java class name. |
Signature |
getSignature()
|
java.lang.Object |
getVariable(int n)
Gets the numbered Plan variable. |
java.lang.Object |
getVariable(java.lang.String name)
Gets the named Plan variable. |
java.lang.String |
getVariableValue(int n)
Converts the value of the numbered variable to a String as if it had been appended to "". |
java.lang.String |
getVariableValue(java.lang.String name)
Converts the value of the named variable to a String as if it had been appended to "". |
java.lang.String |
handledEvent()
|
boolean |
isSame(aos.jack.jak.trace.PlanIntrospection that)
Tests if the underlying object represents the same Plan instance as this one. |
java.lang.String[] |
logSignatureVariableTypes()
Gets a String array of the type names of the Plan's logical signature variables. |
java.lang.String[] |
objSignatureVariableNames()
Gets a String array of the names of the Plan's non-logical signature variables. |
java.lang.String[] |
objSignatureVariableTypes()
Gets a String array of the type names of the Plan's non-logical signature variables. |
aos.jack.jak.plan.PlanFSM |
pass()
Default pass() method for plans that declare no pass method of their own. |
java.lang.String[] |
reasoningMethods()
Gets a String array of the names of the Plan's reasoning methods. |
java.lang.String |
toString()
Returns the plan name. |
java.lang.String[] |
variableNames()
Gets a String array of the names of the Plan's variables. |
java.lang.String[] |
variableTypes()
Gets a String array of the type names of the Plan's variables. |
void |
warning(java.lang.String s)
Utility method for producing qualified warnings |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Plan()
Method Detail |
public aos.jack.jak.rvt.MonitorID getMonitor()
public java.lang.String toString()
public void warning(java.lang.String s)
public java.lang.String[] variableNames()
public java.lang.String[] variableTypes()
variableNames
.
public java.lang.String getVariableValue(int n)
public java.lang.String getVariableValue(java.lang.String name)
public java.lang.Object getVariable(int n)
public java.lang.Object getVariable(java.lang.String name)
public java.lang.String getPlanName()
Plan
, as a fully qualified
Java class name.
Plan
public boolean isSame(aos.jack.jak.trace.PlanIntrospection that)
For a Plan
, no other Object
is the same.
It's only the same as itself.
this
and that
represent the
same Plan
instancepublic java.lang.String[] logSignatureVariableTypes()
logSignatureVariableNames
.
public java.lang.String[] objSignatureVariableNames()
Signature
so it is essential that the
Signature
construction agrees with this.
public java.lang.String[] objSignatureVariableTypes()
objSignatureVariableNames
.
public java.lang.String[] reasoningMethods()
public Agent getAgent()
public PlanInstanceInfo getInstanceInfo()
public java.lang.String describe()
public java.lang.String handledEvent()
public Cursor context()
public abstract aos.jack.jak.plan.PlanFSM body()
public aos.jack.jak.plan.PlanFSM pass()
public aos.jack.jak.plan.PlanFSM fail()
public Cursor elapsedMillis(long time, Timer tm)
time
- The time to elapsetm
- The timer with which to measure the passage of time.
public Cursor elapsedMillis(long time)
time
- The time to elapse.
public Cursor afterMillis(long time, Timer tm)
time
- The absolute time to wait until.
public Cursor afterMillis(long time)
time
- the absolute time to wait until.
public Cursor elapsed(double time)
time
- The elapsed time to wait.
public Cursor elapsed(double time, Timer tm)
time
- The elapsed time to wait.tm
- The timer to use to measure the passage of time.
public Cursor after(double time)
time
- The absolute time to wait until.
public Cursor after(double time, Timer tm)
time
- The absolute time to wait until.tm
- The timer to use to measure the time.
public Signature getSignature()
|
JACK 5.4 Application Interface | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
US Government Restricted Rights
The JACK Modules and relevant Software Material have been developed entirely at private expense and are accordingly provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013 or subparagraph (c)(1) and (2) of the Commercial Computer Software Restricted Rights and 48 CFR 52.2270-19, as applicable.