#include <Spell.h>

Inheritance diagram for gams::algorithms::Spell:

Public Member Functions
	Spell (const std::string &group, std::string text, pose::Pose origin, double height, double width, double buffer, const std::string &barrier, madara::knowledge::KnowledgeBase knowledge=0, platforms::BasePlatform platform=0, variables::Sensors sensors=0, variables::Self self=0)
	Constructor. 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...

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 Attributes
variables::Agents *	agents_
	the list of agents potentially participating in the algorithm More...

madara::knowledge::containers::Barrier	barrier_
	a barrier between all agents before steps can proceed More...

double	buffer_
	the expected buffer between letters in meters More...

int	count_

unsigned int	executions_
	number of executions More...

groups::GroupBase *	group_
	the group that the user wishes the algorithm to use More...

groups::GroupFactoryRepository	group_factory_
	factory for interacting with user-defined groups More...

groups::AgentVector	group_members_
	a convenience list of all current group members More...

double	height_
	the height of the letters to spell in meters More...

int	index_
	the index of the agent in the member list More...

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

pose::Position	next_pos_
	the next position to go to More...

int	node_

pose::Pose	origin_
	the origin of the spelled word/phrase More...

platforms::BasePlatform *	platform_
	provides access to the platform 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...

size_t	step_
	the step count in the waypoint list More...

std::string	text_

double	width_
	the width of the letters to spell in meters More...

Detailed Description

Definition at line 78 of file Spell.h.

Constructor & Destructor Documentation

◆ Spell()

gams::algorithms::Spell::Spell	(	const std::string &	group,
		std::string	text,
		pose::Pose	origin,
		double	height,
		double	width,
		double	buffer,
		const std::string &	barrier,
		madara::knowledge::KnowledgeBase *	knowledge = `0`,
		platforms::BasePlatform *	platform = `0`,
		variables::Sensors *	sensors = `0`,
		variables::Self *	self = `0`
	)

Constructor.

Parameters

group	group name of agents to use. Agents drawn from list in-order, 3 per character
text	text to form
origin	location of upper left corner of first letter; rotation portion deterimines direction: Z-axis points upwards, normal to plane of text X-axis is direction letters flow towards
height	height of letters(in meters)
width	width of letters(in width; all are fixed-width)
buffer	distance between letters
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

Member Function Documentation

◆ analyze()

virtual int gams::algorithms::Spell::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::Spell::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_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.

◆ plan()

virtual int gams::algorithms::Spell::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

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::BaseAlgorithm::agents_

protectedinherited

the list of agents potentially participating in the algorithm

Definition at line 201 of file BaseAlgorithm.h.

◆ barrier_

madara::knowledge::containers::Barrier gams::algorithms::Spell::barrier_

protected

a barrier between all agents before steps can proceed

Definition at line 162 of file Spell.h.

◆ buffer_

double gams::algorithms::Spell::buffer_

protected

the expected buffer between letters in meters

Definition at line 150 of file Spell.h.

◆ count_

int gams::algorithms::Spell::count_

protected

Definition at line 153 of file Spell.h.

◆ executions_

unsigned int gams::algorithms::BaseAlgorithm::executions_

protectedinherited

number of executions

Definition at line 204 of file BaseAlgorithm.h.

◆ group_

groups::GroupBase* gams::algorithms::Spell::group_

protected

the group that the user wishes the algorithm to use

Definition at line 135 of file Spell.h.

◆ group_factory_

groups::GroupFactoryRepository gams::algorithms::Spell::group_factory_

protected

factory for interacting with user-defined groups

Definition at line 132 of file Spell.h.

◆ group_members_

groups::AgentVector gams::algorithms::Spell::group_members_

protected

a convenience list of all current group members

Definition at line 138 of file Spell.h.

◆ height_

double gams::algorithms::Spell::height_

protected

the height of the letters to spell in meters

Definition at line 144 of file Spell.h.

◆ index_

int gams::algorithms::Spell::index_

protected

the index of the agent in the member list

Definition at line 153 of file Spell.h.

◆ knowledge_

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

protectedinherited

provides access to the knowledge base

Definition at line 207 of file BaseAlgorithm.h.

◆ next_pos_

pose::Position gams::algorithms::Spell::next_pos_

protected

the next position to go to

Definition at line 156 of file Spell.h.

◆ node_

int gams::algorithms::Spell::node_

protected

Definition at line 153 of file Spell.h.

◆ origin_

pose::Pose gams::algorithms::Spell::origin_

protected

the origin of the spelled word/phrase

Definition at line 141 of file Spell.h.

◆ platform_

platforms::BasePlatform* gams::algorithms::BaseAlgorithm::platform_

protectedinherited

provides access to the platform

Definition at line 210 of file BaseAlgorithm.h.

◆ self_

variables::Self* gams::algorithms::BaseAlgorithm::self_

protectedinherited

the algorithm's concept of self

Definition at line 213 of file BaseAlgorithm.h.

◆ sensors_

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.

◆ step_

size_t gams::algorithms::Spell::step_

protected

the step count in the waypoint list

Definition at line 159 of file Spell.h.

◆ text_

std::string gams::algorithms::Spell::text_

protected

Definition at line 129 of file Spell.h.

◆ width_

double gams::algorithms::Spell::width_

protected

the width of the letters to spell in meters

Definition at line 147 of file Spell.h.

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

src/gams/algorithms/Spell.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Spell()

Member Function Documentation

◆ analyze()

◆ execute()

◆ get_agents()

◆ get_algorithm_status()

◆ get_knowledge_base()

◆ get_platform()

◆ get_self()

◆ get_sensors()

◆ plan()

◆ set_agents()

◆ set_platform()

◆ set_self()

◆ set_sensors()

Member Data Documentation

◆ agents_

◆ barrier_

◆ buffer_

◆ count_

◆ executions_

◆ group_

◆ group_factory_

◆ group_members_

◆ height_

◆ index_

◆ knowledge_

◆ next_pos_

◆ node_

◆ origin_

◆ platform_

◆ self_

◆ sensors_

◆ status_

◆ step_

◆ text_

◆ width_