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

removes a plan by the plan trigger. More...

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

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 remove ( @Nonnull final ITrigger.EType p_trigger, @Nonnull final ITerm p_literal, @Nonnull final IAgent<?> p_agent)
 removes the plan based on the trigger More...
 

Static Private Attributes

static final long serialVersionUID = -2509947123811973880L
 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 action moves all plan based on the input trigger arguments, the action fails on wrong input

agent/removeplan( "+!", "myplan(X)", "-!", Literal );

Definition at line 54 of file CRemovePlan.java.

Member Function Documentation

◆ execute()

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

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

Definition at line 71 of file CRemovePlan.java.

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.CRemovePlan.remove().

+ Here is the call graph for this function:

◆ minimalArgumentNumber()

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

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 64 of file CRemovePlan.java.

◆ remove()

static boolean org.lightjason.agentspeak.action.builtin.agent.CRemovePlan.remove ( @Nonnull final ITrigger.EType  p_trigger,
@Nonnull final ITerm  p_literal,
@Nonnull final IAgent<?>  p_agent 
)
staticprivate
Parameters
p_triggertrigger type
p_literalliteral as string or literal object
p_agentagent
Returns
flag to remove plan successfully

Definition at line 92 of file CRemovePlan.java.

References org.lightjason.agentspeak.language.instantiable.plan.trigger.CTrigger.from(), org.lightjason.agentspeak.language.CLiteral.parse(), and org.lightjason.agentspeak.language.CCommon.rawvalueAssignableTo().

Referenced by org.lightjason.agentspeak.action.builtin.agent.CRemovePlan.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.CRemovePlan.serialVersionUID = -2509947123811973880L
staticprivate

Definition at line 60 of file CRemovePlan.java.