gams::algorithms::area_coverage::UniformRandomEdgeCoverageFactory Class Reference

A factory class for creating uniform random edge coverage algorithms. More...

#include <UniformRandomEdgeCoverage.h>

Inheritance diagram for gams::algorithms::area_coverage::UniformRandomEdgeCoverageFactory:

Public Member Functions
virtual BaseAlgorithm *	create (const madara::knowledge::KnowledgeMap &args, madara::knowledge::KnowledgeBase *knowledge, platforms::BasePlatform *platform, variables::Sensors *sensors, variables::Self *self, variables::Agents *agents)
	Creates a uniform random edge coverage algorithm. More...
void	set_agents (variables::Agents *agents)
	Sets list of agents participating in swarm. More...
void	set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
	Sets the knowledge base. More...
void	set_platform (platforms::BasePlatform *platform)
	Sets the map of platform names to platform information. More...
void	set_self (variables::Self *self)
	Sets self-referencing variables. More...
void	set_sensors (variables::Sensors *sensors)
	Sets the map of sensor names to sensor information. More...

Protected Attributes
variables::Agents *	agents_
	list of agents participating in the swarm More...
madara::knowledge::KnowledgeBase *	knowledge_
	knowledge base containing variables More...
platforms::BasePlatform *	platform_
	platform variables More...
variables::Self *	self_
	self-referencing variables More...
variables::Sensors *	sensors_
	sensor variables More...

Detailed Description

A factory class for creating uniform random edge coverage algorithms.

Definition at line 125 of file UniformRandomEdgeCoverage.h.

Member Function Documentation

create()

virtual BaseAlgorithm* gams::algorithms::area_coverage::UniformRandomEdgeCoverageFactory::create ( const madara::knowledge::KnowledgeMap &  args, madara::knowledge::KnowledgeBase *  knowledge, platforms::BasePlatform *  platform, variables::Sensors *  sensors, variables::Self *  self, variables::Agents *  agents  )

virtual

Creates a uniform random edge coverage algorithm.

Parameters

args	args[0] = region id
knowledge	the knowledge base to use
platform	the platform. This will be set by the controller in init_vars.
sensors	the sensor info. This will be set by the controller in init_vars.
self	self-referencing variables. This will be set by the controller in init_vars
agents	the list of agents, which is dictated by init_vars when a number of processes is set. This will be set by the controller in init_vars

Implements gams::algorithms::AlgorithmFactory.

set_agents()

void gams::algorithms::AlgorithmFactory::set_agents ( variables::Agents *  agents )

inherited

Sets list of agents participating in swarm.

Parameters

agents

agents in the swarm

set_knowledge()

void gams::algorithms::AlgorithmFactory::set_knowledge ( madara::knowledge::KnowledgeBase *  knowledge )

inherited

Sets the knowledge base.

Parameters

knowledge

the knowledge base to use

set_platform()

void gams::algorithms::AlgorithmFactory::set_platform ( platforms::BasePlatform *  platform )

inherited

Sets the map of platform names to platform information.

Parameters

platform

the platform to use

set_self()

void gams::algorithms::AlgorithmFactory::set_self ( variables::Self *  self )

inherited

Sets self-referencing variables.

Parameters

self	self-referencing variables

set_sensors()

void gams::algorithms::AlgorithmFactory::set_sensors ( variables::Sensors *  sensors )

inherited

Sets the map of sensor names to sensor information.

Parameters

sensors

map of sensor names to sensor information

Member Data Documentation

agents_

variables::Agents* gams::algorithms::AlgorithmFactory::agents_

protectedinherited

list of agents participating in the swarm

Definition at line 139 of file AlgorithmFactory.h.

knowledge_

madara::knowledge::KnowledgeBase* gams::algorithms::AlgorithmFactory::knowledge_

protectedinherited

knowledge base containing variables

Definition at line 136 of file AlgorithmFactory.h.

platform_

platforms::BasePlatform* gams::algorithms::AlgorithmFactory::platform_

protectedinherited

platform variables

Definition at line 142 of file AlgorithmFactory.h.

self_

variables::Self* gams::algorithms::AlgorithmFactory::self_

protectedinherited

self-referencing variables

Definition at line 145 of file AlgorithmFactory.h.

sensors_

variables::Sensors* gams::algorithms::AlgorithmFactory::sensors_

protectedinherited

sensor variables

Definition at line 148 of file AlgorithmFactory.h.

---

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

• src/gams/algorithms/area_coverage/UniformRandomEdgeCoverage.h