gams::variables::Swarm Class Reference

A container for swarm information. More...

#include <Swarm.h>

Public Member Functions
	Swarm ()
	Constructor. More...
	~Swarm ()
	Destructor. More...
void	init_vars (madara::knowledge::KnowledgeBase &knowledge, const madara::knowledge::KnowledgeRecord::Integer &swarm_size=1)
	Initializes variable containers. More...
void	init_vars (madara::knowledge::Variables &knowledge, const madara::knowledge::KnowledgeRecord::Integer &swarm_size=1)
	Initializes variable containers. More...
void	operator= (const Swarm &agent)
	Assignment operator. More...

Public Attributes
AccentStatuses	accents
	container for accents More...
madara::knowledge::containers::String	algorithm
	the current command given to the swarm More...
madara::knowledge::containers::Map	algorithm_args
	number of arguments for command More...
madara::knowledge::containers::Integer	algorithm_id
	the current command given to the swarm More...
madara::knowledge::containers::Double	min_alt
	minimum altitude for swarm to use More...
madara::knowledge::containers::Integer	size
	the number of agents participating in the swarm More...

Protected Member Functions
void	init_vars (const madara::knowledge::KnowledgeRecord::Integer &swarm_size)
	Variable setup. More...

Detailed Description

A container for swarm information.

Definition at line 75 of file Swarm.h.

Constructor & Destructor Documentation

Swarm()

gams::variables::Swarm::Swarm

(

)

Constructor.

~Swarm()

gams::variables::Swarm::~Swarm

(

)

Destructor.

Member Function Documentation

init_vars() [1/3]

void gams::variables::Swarm::init_vars ( const madara::knowledge::KnowledgeRecord::Integer &  swarm_size )

protected

Variable setup.

Parameters

swarm_size

number of participating agents

init_vars() [2/3]

void gams::variables::Swarm::init_vars	(	madara::knowledge::KnowledgeBase &	knowledge,
		const madara::knowledge::KnowledgeRecord::Integer &	swarm_size = 1
	)

Initializes variable containers.

Parameters

knowledge	the variable context
swarm_size	size of the swarm

init_vars() [3/3]

void gams::variables::Swarm::init_vars	(	madara::knowledge::Variables &	knowledge,
		const madara::knowledge::KnowledgeRecord::Integer &	swarm_size = 1
	)

Initializes variable containers.

Parameters

knowledge	the variable context
swarm_size	size of the swarm

operator=()

void gams::variables::Swarm::operator=

(

const Swarm &

agent

)

Assignment operator.

Parameters

agent

agent to copy

Member Data Documentation

accents

AccentStatuses gams::variables::Swarm::accents

container for accents

Definition at line 126 of file Swarm.h.

algorithm

madara::knowledge::containers::String gams::variables::Swarm::algorithm

the current command given to the swarm

Definition at line 111 of file Swarm.h.

algorithm_args

madara::knowledge::containers::Map gams::variables::Swarm::algorithm_args

number of arguments for command

Definition at line 117 of file Swarm.h.

algorithm_id

madara::knowledge::containers::Integer gams::variables::Swarm::algorithm_id

the current command given to the swarm

Definition at line 114 of file Swarm.h.

min_alt

madara::knowledge::containers::Double gams::variables::Swarm::min_alt

minimum altitude for swarm to use

Definition at line 120 of file Swarm.h.

size

madara::knowledge::containers::Integer gams::variables::Swarm::size

the number of agents participating in the swarm

Definition at line 123 of file Swarm.h.

---

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

• src/gams/variables/Swarm.h