An algorithm for covering an area in formation with a synchronous model of computation. More...

#include <GroupBarrier.h>

Inheritance diagram for gams::algorithms::GroupBarrier:

Public Member Functions
	GroupBarrier (const std::vector< std::string > &members, std::string barrier_name, double interval, madara::knowledge::KnowledgeBase knowledge=0, platforms::BasePlatform platform=0, variables::Sensors sensors=0, variables::Self self=0)
	Constructor. More...

	~GroupBarrier ()
	Destructor. More...

virtual int	analyze (void)
	Analyzes environment, platform, or other information. More...

virtual int	execute (void)
	Plans the next execution of the algorithm. More...

variables::Agents *	get_agents (void)
	Gets the list of agents. More...

variables::AlgorithmStatus *	get_algorithm_status (void)
	Gets algorithm status variables. More...

madara::knowledge::KnowledgeBase *	get_knowledge_base (void)
	Gets the knowledge base. More...

platforms::BasePlatform *	get_platform (void)
	Gets the platform. More...

variables::Self *	get_self (void)
	Gets self-defined variables. More...

variables::Sensors *	get_sensors (void)
	Gets the available sensor information. More...

void	operator= (const GroupBarrier &rhs)
	Assignment operator. More...

virtual int	plan (void)
	Plans the next execution of the algorithm. More...

virtual void	set_agents (variables::Agents *agents)
	Sets the list of agents in the swarm. More...

virtual void	set_platform (platforms::BasePlatform *platform)
	Sets the platform. More...

virtual void	set_self (variables::Self *self)
	Sets the map of sensor names to sensor information. More...

virtual void	set_sensors (variables::Sensors *sensors)
	Sets the map of sensor names to sensor information. More...

Protected Member Functions
int	get_position_in_member_list (std::string id, std::vector< std::string > &member_list)
	Gets the position of the id in the member list. More...

Protected Attributes
variables::Agents *	agents_
	the list of agents potentially participating in the algorithm More...

madara::knowledge::containers::Barrier	barrier_
	movement barrier More...

madara::utility::EpochEnforcer< std::chrono::steady_clock >	enforcer_
	enforcer of barrier times More...

unsigned int	executions_
	number of executions More...

madara::knowledge::KnowledgeBase *	knowledge_
	provides access to the knowledge base More...

std::vector< std::string >	members_
	members of the formation(e.g., agent.0, agent.1, etc.) More...

platforms::BasePlatform *	platform_
	provides access to the platform More...

int	position_
	position in member assignment More...

variables::Self *	self_
	the algorithm's concept of self More...

variables::Sensors *	sensors_
	provides access to sensor information More...

variables::AlgorithmStatus	status_
	provides access to status information for this platform More...

Detailed Description

An algorithm for covering an area in formation with a synchronous model of computation.

Allows specification of arbitrary group or swarm.

Definition at line 79 of file GroupBarrier.h.

Constructor & Destructor Documentation

◆ GroupBarrier()

gams::algorithms::GroupBarrier::GroupBarrier	(	const std::vector< std::string > &	members,
		std::string	barrier_name,
		double	interval,
		madara::knowledge::KnowledgeBase *	knowledge = `0`,
		platforms::BasePlatform *	platform = `0`,
		variables::Sensors *	sensors = `0`,
		variables::Self *	self = `0`
	)

Constructor.

Parameters

members	the members of the formation
barrier_name	the barrier name to synchronize on
interval	interval in seconds between barrier increments
knowledge	the context containing variables and values
platform	the underlying platform the algorithm will use
sensors	map of sensor names to sensor information
self	self-referencing variables

◆ ~GroupBarrier()

gams::algorithms::GroupBarrier::~GroupBarrier ( )

Destructor.

Member Function Documentation

◆ analyze()

virtual int gams::algorithms::GroupBarrier::analyze ( void )

virtual

Analyzes environment, platform, or other information.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ execute()

virtual int gams::algorithms::GroupBarrier::execute ( void )

virtual

Plans the next execution of the algorithm.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ get_agents()

variables::Agents* gams::algorithms::BaseAlgorithm::get_agents ( void )

inherited

Gets the list of agents.

◆ get_algorithm_status()

variables::AlgorithmStatus* gams::algorithms::BaseAlgorithm::get_algorithm_status ( void )

inherited

Gets algorithm status variables.

◆ get_knowledge_base()

madara::knowledge::KnowledgeBase* gams::algorithms::BaseAlgorithm::get_knowledge_base ( void )

inherited

Gets the knowledge base.

◆ get_platform()

platforms::BasePlatform* gams::algorithms::BaseAlgorithm::get_platform ( void )

inherited

Gets the platform.

◆ get_position_in_member_list()

int gams::algorithms::GroupBarrier::get_position_in_member_list	(	std::string	id,
		std::vector< std::string > &	member_list
	)

protected

Gets the position of the id in the member list.

Parameters

id	the id of the member
member_list	the list of members

Returns: the position of the id in the member list. -1 if not found.

◆ get_self()

variables::Self* gams::algorithms::BaseAlgorithm::get_self ( void )

inherited

Gets self-defined variables.

◆ get_sensors()

variables::Sensors* gams::algorithms::BaseAlgorithm::get_sensors ( void )

inherited

Gets the available sensor information.

◆ operator=()

void gams::algorithms::GroupBarrier::operator= ( const GroupBarrier & rhs )

Assignment operator.

Parameters

rhs	values to copy

◆ plan()

virtual int gams::algorithms::GroupBarrier::plan ( void )

virtual

Plans the next execution of the algorithm.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ set_agents()

virtual void gams::algorithms::BaseAlgorithm::set_agents ( variables::Agents * agents )

virtualinherited

Sets the list of agents in the swarm.

Parameters

agents list of agents

◆ set_platform()

virtual void gams::algorithms::BaseAlgorithm::set_platform ( platforms::BasePlatform * platform )

virtualinherited

Sets the platform.

Parameters

platform the underlying platform the algorithm will use

◆ set_self()

virtual void gams::algorithms::BaseAlgorithm::set_self ( variables::Self * self )

virtualinherited

Sets the map of sensor names to sensor information.

Parameters

self	pointer to self-referencing variables container

◆ set_sensors()

virtual void gams::algorithms::BaseAlgorithm::set_sensors ( variables::Sensors * sensors )

virtualinherited

variables::Sensors* gams::algorithms::BaseAlgorithm::sensors_

protectedinherited

provides access to sensor information

Definition at line 216 of file BaseAlgorithm.h.

◆ status_

variables::AlgorithmStatus gams::algorithms::BaseAlgorithm::status_

protectedinherited

provides access to status information for this platform

Definition at line 219 of file BaseAlgorithm.h.

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

src/gams/algorithms/GroupBarrier.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GroupBarrier()

◆ ~GroupBarrier()

Member Function Documentation

◆ analyze()

◆ execute()

◆ get_agents()

◆ get_algorithm_status()

◆ get_knowledge_base()

◆ get_platform()

◆ get_position_in_member_list()

◆ get_self()

◆ get_sensors()

◆ operator=()

◆ plan()

◆ set_agents()

◆ set_platform()

◆ set_self()

◆ set_sensors()

Member Data Documentation

◆ agents_

◆ barrier_

◆ enforcer_

◆ executions_

◆ knowledge_

◆ members_

◆ platform_

◆ position_

◆ self_

◆ sensors_

◆ status_