org.lightvoting.simulation.action.message.CSend Class Reference

Action to send messages for communication. More...

Inherits IBaseAction.

Collaboration diagram for org.lightvoting.simulation.action.message.CSend:

Public Member Functions
final IFuzzyValue< Boolean >	execute (final IContext p_context, final boolean p_parallel, final List< ITerm > p_argument, final List< ITerm > p_return)
final int	minimalArgumentNumber ()
final IPath	name ()
final CVotingAgent	register (final CVotingAgent p_agent)
	Register a new agent. More...
final CVotingAgent	unregister (final CVotingAgent p_agent)
	Unregisters agent Removes agent from map. More...

Private Attributes
final Map< String, CVotingAgent >	m_agents = new ConcurrentHashMap<>()
	thread-safe map for storing name and agent object More...

Detailed Description

Based on/credits to https://lightjason.github.io/tutorials/communication/

Definition at line 49 of file CSend.java.

Member Function Documentation

final IFuzzyValue<Boolean> org.lightvoting.simulation.action.message.CSend.execute	(	final IContext	p_context,
		final boolean	p_parallel,
		final List< ITerm >	p_argument,
		final List< ITerm >	p_return
	)

first parameter of the action is the name of the receiving agent

Definition at line 90 of file CSend.java.

    {
        final IAgent<?> l_receiver = m_agents.get( p_argument.get( 0 ).<String>raw() );

        // if the agent is it not found, action fails
        if ( l_receiver == null )
            return CFuzzyValue.from( false );

        // create the receiving goal-trigger of the message
        l_receiver.trigger(
                CTrigger.from(
                        ITrigger.EType.ADDGOAL,

                        // create the goal literal "message/receive(M,S)" with M is the message literal
                        // and S the sending agent name
                        CLiteral.from(
                                "message/receive",

                                // message literal
                                CLiteral.from(
                                        "message",

                                        // first argument is the agent name so copy all other arguments to the message literal
                                        p_argument.subList( 1, p_argument.size() ).stream().map( i -> CRawTerm.from( i.raw() ) )
                                ),

                                // name of the sending agent in this the agent which calls the send action is read from
                                // context and translate in the communication agent, the communication agent has got the
                                // method name() to read the agent name
                                CLiteral.from( "from", CRawTerm.from( p_context.agent().<CVotingAgent>raw().name() ) )
                        )

                )
        );

        return CFuzzyValue.from( true );
    }

final int org.lightvoting.simulation.action.message.CSend.minimalArgumentNumber

(

)

Definition at line 84 of file CSend.java.

    {
        return 2;
    }

final IPath org.lightvoting.simulation.action.message.CSend.name

(

)

Definition at line 78 of file CSend.java.

    {
        return CPath.from( "message/send" );
    }

final CVotingAgent org.lightvoting.simulation.action.message.CSend.register

(

final CVotingAgent

p_agent

)

Parameters

p_agent

agent object

Returns

object of registered agent

Definition at line 60 of file CSend.java.

    {
        m_agents.put( p_agent.name(), p_agent );
        return p_agent;
    }

final CVotingAgent org.lightvoting.simulation.action.message.CSend.unregister

(

final CVotingAgent

p_agent

)

Parameters

p_agent

agent object

Returns

object of unregistered agent

Definition at line 71 of file CSend.java.

    {
        m_agents.remove( p_agent.name() );
        return p_agent;
    }

Member Data Documentation

final Map<String, CVotingAgent> org.lightvoting.simulation.action.message.CSend.m_agents = new ConcurrentHashMap<>()

private

Definition at line 54 of file CSend.java.