LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.agent.CGetPlan Class Reference

action to get plan objects. More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.agent.CGetPlan:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.agent.CGetPlan:

Public Member Functions

final IFuzzyValue< Boolean > execute (final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List< ITerm > p_argument, @Nonnull final List< ITerm > p_return)
 defines a plan-body operation More...
final int minimalArgumentNumber ()
 minimum number of arguments More...
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
final IPath name ()
 returns the name with path of the action More...
- Public Member Functions inherited from org.lightjason.agentspeak.action.IBaseAction
final boolean equals (final Object p_object)
final int hashCode ()
final String toString ()
- Public Member Functions inherited from org.lightjason.agentspeak.action.IAction
default Stream< IVariable<?> > variables ()
 returns a stream with all used variables More...

Static Private Member Functions

static boolean query ( @Nonnull final ITrigger.EType p_trigger, @Nonnull final ITerm p_literal, @Nonnull final IAgent<?> p_agent, @Nonnull final List< ITerm > p_return)
 query tha plan from an agent More...

Static Private Attributes

static final long serialVersionUID = 2674034436717184541L
 serial id More...

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.action.IAction
long serialVersionUID = -6374480398439703170L
 serial id More...
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
 IBuiltinAction ()
 ctor More...
 IBuiltinAction (final int p_length)
 ctor More...
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
static final Logger LOGGER = CCommon.logger( IBuiltinAction.class )
 logger More...
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.IBaseAction
static final Logger LOGGER = org.lightjason.agentspeak.common.CCommon.logger( IAction.class )
 logger More...

Detailed Description

The actions returns a list of plans of a trigger, the arguments are tuples of a string with the trigger sequence (+!, +, -, -!) and a string or literal, the plan name, for each tuple the plan object will returned within a list, the action fails on non-existing plan

[L1|L2] = agent/getplan( "+!", "myplan(X)", "-!", Literal );

Definition at line 60 of file

Member Function Documentation

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.agent.CGetPlan.execute ( final boolean  p_parallel,
@Nonnull final IContext  p_context,
@Nonnull final List< ITerm p_argument,
@Nonnull final List< ITerm p_return 
p_parallelparallel execution
p_contextcurrent execution context
p_argumentparameter of the action
p_returnreturn values
fuzzy boolean

Implements org.lightjason.agentspeak.language.execution.IExecution.

Definition at line 76 of file

References org.lightjason.agentspeak.language.CCommon.flatten(), org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from(), org.lightjason.agentspeak.language.instantiable.plan.trigger.ITrigger.EType.from(), and org.lightjason.agentspeak.action.builtin.agent.CGetPlan.query().

Referenced by org.lightjason.agentspeak.action.builtin.TestCActionAgent.getplan().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ minimalArgumentNumber()

final int org.lightjason.agentspeak.action.builtin.agent.CGetPlan.minimalArgumentNumber ( )
number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 69 of file

◆ query()

static boolean org.lightjason.agentspeak.action.builtin.agent.CGetPlan.query ( @Nonnull final ITrigger.EType  p_trigger,
@Nonnull final ITerm  p_literal,
@Nonnull final IAgent<?>  p_agent,
@Nonnull final List< ITerm p_return 
p_triggertrigger type
p_literalliteral as string or literal object
p_returnlist with return arguments
flag to query plan successfully

Definition at line 98 of file

References org.lightjason.agentspeak.language.instantiable.plan.trigger.CTrigger.from(), org.lightjason.agentspeak.language.CRawTerm< T >.from(), org.lightjason.agentspeak.language.CLiteral.parse(), org.lightjason.agentspeak.language.instantiable.plan.statistic.IPlanStatistic.plan(), and org.lightjason.agentspeak.language.CCommon.rawvalueAssignableTo().

Referenced by org.lightjason.agentspeak.action.builtin.agent.CGetPlan.execute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.agent.CGetPlan.serialVersionUID = 2674034436717184541L

Definition at line 65 of file