gams::elections::ElectionFactoryRepository Class Reference

A repository for election factories. More...

#include <ElectionFactoryRepository.h>

Public Member Functions
	ElectionFactoryRepository (const std::string &agent_prefix, madara::knowledge::KnowledgeBase *knowledge=0)
	Constructor. More...
virtual	~ElectionFactoryRepository ()
	Destructor. More...
void	add (ElectionType type, ElectionFactory *factory)
	Adds an algorithm factory. More...
ElectionBase *	create (const std::string &election_prefix)
	Creates an election based on type. More...
ElectionBase *	create (ElectionType type)
	Creates an election based on type. More...
void	set_agent_prefix (const std::string &prefix)
	Sets the prefix for the current voting agent. More...
void	set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
	Sets the knowledge base. More...

Protected Member Functions
void	init (void)
	Initializes factories for all supported GAMS elections. More...

Protected Attributes
std::string	agent_prefix_
	self prefix of the agent More...
ElectionFactoryMap	factory_map_
	a mapping of types to election factories More...
madara::knowledge::KnowledgeBase *	knowledge_
	knowledge base containing variables More...

Detailed Description

A repository for election factories.

Definition at line 76 of file ElectionFactoryRepository.h.

Constructor & Destructor Documentation

gams::elections::ElectionFactoryRepository::ElectionFactoryRepository	(	const std::string &	agent_prefix,
		madara::knowledge::KnowledgeBase *	knowledge = 0
	)

Constructor.

Parameters

agent_prefix	the name of this voter (e.g. agent.0)
knowledge	a knowledge base where election info is

virtual gams::elections::ElectionFactoryRepository::~ElectionFactoryRepository ( )

virtual

Destructor.

Member Function Documentation

void gams::elections::ElectionFactoryRepository::add	(	ElectionType	type,
		ElectionFactory *	factory
	)

Adds an algorithm factory.

Parameters

type	the type for this factory
factory	the factory for creating an algorithm

Returns

the new algorithm

ElectionBase* gams::elections::ElectionFactoryRepository::create

(

const std::string &

election_prefix

)

Creates an election based on type.

Parameters

election_prefix

the name of the election (e.g. election.position)

Returns

the new election

ElectionBase* gams::elections::ElectionFactoryRepository::create

(

ElectionType

type

)

Creates an election based on type.

Parameters

type	the type of the election (

See also

ElectionTypes)

Returns

the new election

void gams::elections::ElectionFactoryRepository::init ( void  )

protected

Initializes factories for all supported GAMS elections.

void gams::elections::ElectionFactoryRepository::set_agent_prefix

(

const std::string &

prefix

)

Sets the prefix for the current voting agent.

Parameters

prefix

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

void gams::elections::ElectionFactoryRepository::set_knowledge

(

madara::knowledge::KnowledgeBase *

knowledge

)

Sets the knowledge base.

Parameters

knowledge

the knowledge base to use

Member Data Documentation

std::string gams::elections::ElectionFactoryRepository::agent_prefix_

protected

self prefix of the agent

Definition at line 141 of file ElectionFactoryRepository.h.

ElectionFactoryMap gams::elections::ElectionFactoryRepository::factory_map_

protected

a mapping of types to election factories

Definition at line 144 of file ElectionFactoryRepository.h.

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

protected

knowledge base containing variables

Definition at line 136 of file ElectionFactoryRepository.h.

---

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

• src/gams/elections/ElectionFactoryRepository.h