Created by sophie on 24.04.17. More...

Collaboration diagram for org.lightvoting.simulation.environment.CGroup:

Public Member Functions
	CGroup (final CVotingAgent p_votingAgent, final String p_grouping)
	constructor More...

void	addCoordinated (final CVotingAgent p_votingAgent)
	add voting agent (for coordinated grouping) More...

void	addRandom (final CVotingAgent p_votingAgent)
	add voting agent (for random grouping) More...

CVotingAgent	determineAgent (final String p_agentName)
	determine agent for given name More...

boolean	electionInProgress ()

boolean	finale ()

ILiteral	literal (final CVotingAgent p_votingAgent)
	returns literal representation for voting agent More...

ILiteral	literal (final CChairAgent p_chairAgent)
	returns literal representation for chair agent, is null if the chair is not the chair of the group More...

void	makeReady ()

boolean	open ()

boolean	readyForElection ()

void	remove (final CVotingAgent p_votingAgent)

void	reopen ()
	reopen group unless capacity is reached More...

void	reset ()
	reset group More...

BitVector	result ()
	return current result More...

int	size ()
	return size More...

void	startProgress ()

void	triggerAgents (final CChairAgent p_chairAgent)
	trigger agents in group More...

ILiteral	updateBasic (final CChairAgent p_chairAgent, final BitVector p_result)
	update group literal for chair agent ( for random grouping ) More...

ILiteral	updateIterative (final CChairAgent p_chairAgent, final BitVector p_result, final int p_iteration)
	update group literal for chair agent ( for random grouping ) More...

Private Attributes
final List< CVotingAgent >	m_agentList

final int	m_capacity = 3

final CChairAgent	m_chair

boolean	m_inProgress

boolean	m_open

boolean	m_readyForElection

BitVector	m_result

Detailed Description

Definition at line 42 of file CGroup.java.

Constructor & Destructor Documentation

org.lightvoting.simulation.environment.CGroup.CGroup	(	final CVotingAgent	p_votingAgent,
		final String	p_grouping
	)

Parameters

p_votingAgent	voting agent creating the group
p_grouping	grouping algorithm

Definition at line 62 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_agentList, org.lightvoting.simulation.environment.CGroup.m_chair, org.lightvoting.simulation.environment.CGroup.m_inProgress, org.lightvoting.simulation.environment.CGroup.m_open, org.lightvoting.simulation.environment.CGroup.m_readyForElection, and org.lightvoting.simulation.environment.CGroup.m_result.

     {
         m_agentList = new LinkedList<>();
         m_agentList.add( p_votingAgent );
         m_chair = p_votingAgent.getChair();
         m_open = true;
         m_result = null;
         if ( "RANDOM".equals( p_grouping ) )
             m_readyForElection = false;
         else
             m_readyForElection = true;
         m_inProgress = false;
     }

Member Function Documentation

void org.lightvoting.simulation.environment.CGroup.addCoordinated ( final CVotingAgent p_votingAgent )

Parameters

p_votingAgent joining voting agent

Definition at line 131 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_open, and org.lightvoting.simulation.environment.CGroup.m_readyForElection.

     {
 
         System.out.println( "Adding agent, old size is " + m_agentList.size() );
         m_agentList.add( p_votingAgent );
         m_open = false;
         m_readyForElection = true;
     }

void org.lightvoting.simulation.environment.CGroup.addRandom ( final CVotingAgent p_votingAgent )

Parameters

p_votingAgent joining voting agent

Definition at line 115 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_agentList, org.lightvoting.simulation.environment.CGroup.m_capacity, org.lightvoting.simulation.environment.CGroup.m_open, and org.lightvoting.simulation.environment.CGroup.m_readyForElection.

     {
         System.out.println( "Adding agent, old size is " + m_agentList.size() );
         m_agentList.add( p_votingAgent );
         if ( m_agentList.size() >= m_capacity )
         {
             m_open = false;
             m_readyForElection = true;
         }
     }

CVotingAgent org.lightvoting.simulation.environment.CGroup.determineAgent ( final String p_agentName )

Parameters

p_agentName name

Returns: corresponding voting agent

Definition at line 286 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_agentList.

     {
         for ( int i = 0; i < m_agentList.size(); i++ )
             if ( p_agentName.equals( m_agentList.get( i ).name() ) )
                 return m_agentList.get( i );
         return null;
     }

boolean org.lightvoting.simulation.environment.CGroup.electionInProgress ( )

Definition at line 150 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_inProgress.

     {
         return m_inProgress;
     }

boolean org.lightvoting.simulation.environment.CGroup.finale ( )

Definition at line 271 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_capacity.

     {
         return m_agentList.size() >= m_capacity;
     }

ILiteral org.lightvoting.simulation.environment.CGroup.literal ( final CVotingAgent p_votingAgent )

Parameters

p_votingAgent voting agent

Returns: literal with chair, status of group, curret voting result and info whether the group contains the agent

Definition at line 82 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_chair, and org.lightvoting.simulation.environment.CGroup.m_result.

     {
         return CLiteral.from( "group", CRawTerm.from( m_chair ), CRawTerm.from( this.open() ), CRawTerm.from( m_result ),
                               CRawTerm.from( m_agentList.contains( p_votingAgent ) ) );
     }

ILiteral org.lightvoting.simulation.environment.CGroup.literal ( final CChairAgent p_chairAgent )

Parameters

p_chairAgent chair agent

Returns: literal with group reference, agents in group, status of group, current voting result )

Definition at line 93 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_agentList, and org.lightvoting.simulation.environment.CGroup.m_chair.

     {
         final List<ITerm> l_terms = new LinkedList<>();
 
         for ( int i = 0; i < m_agentList.size(); i++ )
             l_terms.add( CRawTerm.from( m_agentList.get( i ) ) );
 
 
         if ( ( this.m_chair ).equals( p_chairAgent ) )
             return CLiteral.from( "group", CRawTerm.from( this ) );
         else return null;
     }

void org.lightvoting.simulation.environment.CGroup.makeReady ( )

Definition at line 276 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_readyForElection.

     {
         m_readyForElection = true;
     }

boolean org.lightvoting.simulation.environment.CGroup.open ( )

Definition at line 145 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_open.

     {
         return m_open;
     }

boolean org.lightvoting.simulation.environment.CGroup.readyForElection ( )

Definition at line 106 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_readyForElection.

Referenced by org.lightvoting.simulation.agent.CChairAgent.checkConditions().

     {
         return m_readyForElection;
     }

Here is the caller graph for this function:

void org.lightvoting.simulation.environment.CGroup.remove ( final CVotingAgent p_votingAgent )

Definition at line 140 of file CGroup.java.

     {
         m_agentList.remove( p_votingAgent );
     }

void org.lightvoting.simulation.environment.CGroup.reopen ( )

Definition at line 252 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_agentList, org.lightvoting.simulation.environment.CGroup.m_capacity, and org.lightvoting.simulation.environment.CGroup.m_open.

     {
         if ( m_agentList.size() < m_capacity )
         {
             m_open = true;
         }
     }

void org.lightvoting.simulation.environment.CGroup.reset ( )

Definition at line 243 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_inProgress, and org.lightvoting.simulation.environment.CGroup.m_readyForElection.

     {
         m_inProgress = false;
         m_readyForElection = false;
     }

BitVector org.lightvoting.simulation.environment.CGroup.result ( )

Returns: election result

Definition at line 265 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_result.

     {
         return m_result;
     }

int org.lightvoting.simulation.environment.CGroup.size ( )

Returns: size of agent list

Definition at line 182 of file CGroup.java.

Referenced by org.lightvoting.simulation.agent.CChairAgent.removeVoter().

     {
         return m_agentList.size();
     }

Here is the caller graph for this function:

void org.lightvoting.simulation.environment.CGroup.startProgress ( )

Definition at line 155 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_inProgress.

     {
         m_inProgress = true;
     }

void org.lightvoting.simulation.environment.CGroup.triggerAgents ( final CChairAgent p_chairAgent )

Parameters

p_chairAgent chair agent

Definition at line 164 of file CGroup.java.

     {
         m_agentList.forEach( i ->
             i.trigger(
                 CTrigger.from(
                     ITrigger.EType.ADDGOAL,
                     CLiteral.from(
                         "submit/vote",
                         CRawTerm.from( p_chairAgent ) )
                 )
             )
         );
     }

ILiteral org.lightvoting.simulation.environment.CGroup.updateBasic	(	final CChairAgent	p_chairAgent,
		final BitVector	p_result
	)

Parameters

p_chairAgent	chair agent
p_result	election result

Returns: group literal for chair agent

Definition at line 194 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_result.

Referenced by org.lightvoting.simulation.agent.CChairAgent.computeResult().

     {
         // send result of election to all agents in the group
         m_agentList.stream().forEach( i ->
             i.trigger( CTrigger.from(
                 ITrigger.EType.ADDGOAL,
                 CLiteral.from( "election/result",
                                CRawTerm.from( p_chairAgent ),
                                CRawTerm.from( p_result ) )
                        )
             )
         );
 
         m_result = p_result;
         return this.literal( p_chairAgent );
     }

Here is the caller graph for this function:

ILiteral org.lightvoting.simulation.environment.CGroup.updateIterative	(	final CChairAgent	p_chairAgent,
		final BitVector	p_result,
		final int	p_iteration
	)

Parameters

p_chairAgent	chair agent
p_result	election result
p_iteration	current iteration

Returns: group literal for chair agent

Definition at line 219 of file CGroup.java.

References org.lightvoting.simulation.environment.CGroup.m_result.

Referenced by org.lightvoting.simulation.agent.CChairAgent.computeResult().

     {
         // send result of election to all agents in the group
         m_agentList.stream().forEach( i ->
         {
             i.trigger( CTrigger.from(
                 ITrigger.EType.ADDGOAL,
                 CLiteral.from( "election/result",
                                CRawTerm.from( p_chairAgent ),
                                CRawTerm.from( p_result  ),
                                CRawTerm.from( p_iteration ) )
                        )
             );
             System.out.println( "triggering agent " + i.name() );
         } );
 
         m_result = p_result;
         return this.literal( p_chairAgent );
 
     }