Provides MADARA containers for GAMS-related entities and information. More...

Classes
class	AccentStatus
	A container for accent status information. More...

class	Agent
	A container for agent information. More...

class	AlgorithmStatus
	A container for algorithm status information. More...

class	Grid

class	PlatformStatus
	A container for platform status information. More...

class	Region
	A container for region information. More...

class	SearchArea
	A container for search area information. More...

class	Self
	A container for self referencing information. More...

class	Sensor
	A container for sensor information. More...

class	Swarm
	A container for swarm information. More...

Typedefs
typedef std::vector< AccentStatus >	AccentStatuses
	An array of accents. More...

typedef std::map< std::string, Agent >	AgentMap
	A map of agent prefixes to agent knowledge. More...

typedef std::vector< Agent >	Agents
	An array of agent knowledge. More...

typedef AlgorithmStatus	Algorithm
	deprecated typedef. Please use AlgorithmStatus instead. More...

typedef std::vector< std::string >	AlgorithmNames
	a list of sensor names More...

typedef std::map< std::string, AlgorithmStatus >	Algorithms
	a map of sensor names to the sensor information More...

typedef Algorithms	AlgorithmStatuses
	a typedef for convenience and legibility More...

typedef PlatformStatus	Platform
	deprecated typedef. Please use PlatformStatus instead. More...

typedef std::vector< std::string >	PlatformNames
	a list of sensor names More...

typedef std::map< std::string, PlatformStatus >	Platforms
	a map of sensor names to the sensor information More...

typedef Platforms	PlatformStatuses
	a typedef for convenience and legibility More...

typedef std::vector< std::string >	SensorNames
	a list of sensor names More...

typedef std::map< std::string, Sensor * >	Sensors
	a map of sensor names to the sensor information More...

Functions
GAMS_EXPORT void	init_vars (AccentStatuses &variables, madara::knowledge::KnowledgeBase &knowledge, const std::string &prefix)
	Initializes accent status containers. More...

GAMS_EXPORT void	init_vars (AccentStatuses &variables, madara::knowledge::Variables &knowledge, const std::string &prefix)
	Initializes accent status containers. More...

GAMS_EXPORT void	init_vars (Agents &variables, madara::knowledge::KnowledgeBase &knowledge, const groups::GroupBase &group)
	Initializes agent containers. More...

GAMS_EXPORT void	init_vars (Agents &variables, madara::knowledge::KnowledgeBase &knowledge, const madara::knowledge::KnowledgeRecord::Integer &processes)
	Initializes agent containers. More...

GAMS_EXPORT void	init_vars (Region &variables, madara::knowledge::KnowledgeBase &knowledge, const std::string &region_name="0")
	Initializes region containers. More...

GAMS_EXPORT void	init_vars (SearchArea &variables, madara::knowledge::KnowledgeBase &knowledge, const std::string &area_name="0")
	Initializes search area containers. More...

GAMS_EXPORT void	init_vars (Self &container, madara::knowledge::KnowledgeBase &knowledge, const madara::knowledge::KnowledgeRecord::Integer &id)
	Initializes a self container. More...

GAMS_EXPORT void	init_vars (Self &container, madara::knowledge::KnowledgeBase &knowledge, const std::string &self_prefix)
	Initializes a self container. More...

GAMS_EXPORT void	init_vars (Swarm &variables, madara::knowledge::KnowledgeBase &knowledge, const madara::knowledge::KnowledgeRecord::Integer &swarm_size=1)
	Initializes a swarm container. More...

GAMS_EXPORT void	init_vars (Swarm &variables, madara::knowledge::Variables &knowledge, const madara::knowledge::KnowledgeRecord::Integer &swarm_size=1)
	Initializes a swarm container. More...

Detailed Description

Provides MADARA containers for GAMS-related entities and information.

Typedef Documentation

◆ AccentStatuses

typedef std::vector<AccentStatus> gams::variables::AccentStatuses

An array of accents.

Definition at line 126 of file AccentStatus.h.

◆ AgentMap

typedef std::map<std::string, Agent> gams::variables::AgentMap

A map of agent prefixes to agent knowledge.

Definition at line 251 of file Agent.h.

◆ Agents

typedef std::vector<Agent> gams::variables::Agents

An array of agent knowledge.

Definition at line 246 of file Agent.h.

◆ Algorithm

typedef AlgorithmStatus gams::variables::Algorithm

deprecated typedef. Please use AlgorithmStatus instead.

Definition at line 172 of file AlgorithmStatus.h.

◆ AlgorithmNames

typedef std::vector<std::string> gams::variables::AlgorithmNames

a list of sensor names

Definition at line 181 of file AlgorithmStatus.h.

◆ Algorithms

typedef std::map<std::string, AlgorithmStatus> gams::variables::Algorithms

a map of sensor names to the sensor information

Definition at line 175 of file AlgorithmStatus.h.

◆ AlgorithmStatuses

typedef Algorithms gams::variables::AlgorithmStatuses

a typedef for convenience and legibility

Definition at line 178 of file AlgorithmStatus.h.

◆ Platform

typedef PlatformStatus gams::variables::Platform

deprecated typedef. Please use PlatformStatus instead.

Definition at line 173 of file PlatformStatus.h.

◆ PlatformNames

typedef std::vector<std::string> gams::variables::PlatformNames

a list of sensor names

Definition at line 182 of file PlatformStatus.h.

◆ Platforms

typedef std::map<std::string, PlatformStatus> gams::variables::Platforms

a map of sensor names to the sensor information

Definition at line 176 of file PlatformStatus.h.

◆ PlatformStatuses

typedef Platforms gams::variables::PlatformStatuses

a typedef for convenience and legibility

Definition at line 179 of file PlatformStatus.h.

◆ SensorNames

typedef std::vector<std::string> gams::variables::SensorNames

a list of sensor names

Definition at line 241 of file Sensor.h.

◆ Sensors

typedef std::map<std::string, Sensor*> gams::variables::Sensors

a map of sensor names to the sensor information

Definition at line 238 of file Sensor.h.

Function Documentation

◆ init_vars() [1/10]

GAMS_EXPORT void gams::variables::init_vars	(	AccentStatuses &	variables,
		madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	prefix
	)

Initializes accent status containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
prefix	the prefix of the accents(e.g. swarm/agent)

◆ init_vars() [2/10]

GAMS_EXPORT void gams::variables::init_vars	(	AccentStatuses &	variables,
		madara::knowledge::Variables &	knowledge,
		const std::string &	prefix
	)

Initializes accent status containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
prefix	the prefix of the accents(e.g. swarm/agent)

◆ init_vars() [3/10]

GAMS_EXPORT void gams::variables::init_vars	(	Agents &	variables,
		madara::knowledge::KnowledgeBase &	knowledge,
		const groups::GroupBase &	group
	)

Initializes agent containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
group	a group containing all agents of interest

◆ init_vars() [4/10]

GAMS_EXPORT void gams::variables::init_vars	(	Agents &	variables,
		madara::knowledge::KnowledgeBase &	knowledge,
		const madara::knowledge::KnowledgeRecord::Integer &	processes
	)

Initializes agent containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
processes	the number of processes in the agent swarm

◆ init_vars() [5/10]

GAMS_EXPORT void gams::variables::init_vars	(	Region &	variables,
		madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	region_name = `"0"`
	)

Initializes region containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
region_name	name of the region

◆ init_vars() [6/10]

GAMS_EXPORT void gams::variables::init_vars	(	SearchArea &	variables,
		madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	area_name = `"0"`
	)

Initializes search area containers.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
area_name	name of the area

◆ init_vars() [7/10]

GAMS_EXPORT void gams::variables::init_vars	(	Self &	container,
		madara::knowledge::KnowledgeBase &	knowledge,
		const madara::knowledge::KnowledgeRecord::Integer &	id
	)

Initializes a self container.

Parameters

container	the variables to initialize
knowledge	the knowledge base that houses the variables
id	node identifier

◆ init_vars() [8/10]

GAMS_EXPORT void gams::variables::init_vars	(	Self &	container,
		madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	self_prefix
	)

Initializes a self container.

Parameters

container	the variables to initialize
knowledge	the knowledge base that houses the variables
self_prefix	prefix of variables in the knowledge base

◆ init_vars() [9/10]

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

Initializes a swarm container.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
swarm_size	size of the swarm

◆ init_vars() [10/10]

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

Initializes a swarm container.

Parameters

variables	the variables to initialize
knowledge	the knowledge base that houses the variables
swarm_size	size of the swarm

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ AccentStatuses

◆ AgentMap

◆ Agents

◆ Algorithm

◆ AlgorithmNames

◆ Algorithms

◆ AlgorithmStatuses

◆ Platform

◆ PlatformNames

◆ Platforms

◆ PlatformStatuses

◆ SensorNames

◆ Sensors

Function Documentation

◆ init_vars() [1/10]

◆ init_vars() [2/10]

◆ init_vars() [3/10]

◆ init_vars() [4/10]

◆ init_vars() [5/10]

◆ init_vars() [6/10]

◆ init_vars() [7/10]

◆ init_vars() [8/10]

◆ init_vars() [9/10]

◆ init_vars() [10/10]