gams::elections::ElectionCumulativeFactory Class Reference

Factory for creating plurality elections. More...

#include <ElectionCumulative.h>

Inheritance diagram for gams::elections::ElectionCumulativeFactory:

Public Member Functions
	ElectionCumulativeFactory ()
	Constructor. More...
virtual	~ElectionCumulativeFactory ()
	Destructor. More...
virtual ElectionBase *	create (const std::string &election_prefix="", const std::string &agent_prefix="", madara::knowledge::KnowledgeBase *knowledge=0)
	Creates a plurality election. More...
void	set_agent_prefix (const std::string &prefix)
	Sets the prefix for the current bidding agent. More...
void	set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
	Sets the knowledge base. More...

Protected Attributes
std::string	agent_prefix_
	self prefix of the agent More...
madara::knowledge::KnowledgeBase *	knowledge_
	knowledge base containing variables More...

Detailed Description

Factory for creating plurality elections.

Definition at line 109 of file ElectionCumulative.h.

Constructor & Destructor Documentation

ElectionCumulativeFactory()

gams::elections::ElectionCumulativeFactory::ElectionCumulativeFactory

(

)

Constructor.

~ElectionCumulativeFactory()

virtual gams::elections::ElectionCumulativeFactory::~ElectionCumulativeFactory ( )

virtual

Destructor.

Member Function Documentation

create()

virtual ElectionBase* gams::elections::ElectionCumulativeFactory::create ( const std::string &  election_prefix = "", const std::string &  agent_prefix = "", madara::knowledge::KnowledgeBase *  knowledge = 0  )

virtual

Creates a plurality election.

Parameters

election_prefix	the name of the election(e.g. election.leader)
agent_prefix	the name of this bidder(e.g. agent.0)
knowledge	the knowledge base to use for syncing

Returns

the new group

Implements gams::elections::ElectionFactory.

set_agent_prefix()

void gams::elections::ElectionFactory::set_agent_prefix ( const std::string &  prefix )

inherited

Sets the prefix for the current bidding agent.

Parameters

prefix

the name of the agent(e.g. agent.0)

set_knowledge()

void gams::elections::ElectionFactory::set_knowledge ( madara::knowledge::KnowledgeBase *  knowledge )

inherited

Sets the knowledge base.

Parameters

knowledge

the knowledge base to use

Member Data Documentation

agent_prefix_

std::string gams::elections::ElectionFactory::agent_prefix_

protectedinherited

self prefix of the agent

Definition at line 112 of file ElectionFactory.h.

knowledge_

madara::knowledge::KnowledgeBase* gams::elections::ElectionFactory::knowledge_

protectedinherited

knowledge base containing variables

Definition at line 115 of file ElectionFactory.h.

---

The documentation for this class was generated from the following file:

• src/gams/elections/ElectionCumulative.h