gams::variables::SearchArea Class Reference

A container for search area information. More...

#include <SearchArea.h>

Public Member Functions
	SearchArea ()
	Constructor. More...
	~SearchArea ()
	Destructor. More...
void	init_vars (madara::knowledge::KnowledgeBase &knowledge, const std::string &area_name="0")
	Initializes variable containers. More...
void	init_vars (madara::knowledge::Variables &knowledge, const std::string &area_name="0")
	Initializes variable containers. More...
void	operator= (const SearchArea &rhs)
	Assignment operator. More...

Public Attributes
std::string	name
	region that the named search area points to More...

Detailed Description

A container for search area information.

Definition at line 69 of file SearchArea.h.

Constructor & Destructor Documentation

SearchArea()

gams::variables::SearchArea::SearchArea

(

)

Constructor.

~SearchArea()

gams::variables::SearchArea::~SearchArea

(

)

Destructor.

Member Function Documentation

init_vars() [1/2]

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

Initializes variable containers.

Parameters

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

init_vars() [2/2]

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

Initializes variable containers.

Parameters

knowledge	the variable context
area_name	name of the area

operator=()

void gams::variables::SearchArea::operator=

(

const SearchArea &

rhs

)

Assignment operator.

Parameters

rhs	values to copy

Member Data Documentation

name

std::string gams::variables::SearchArea::name

region that the named search area points to

name of the search area

Definition at line 108 of file SearchArea.h.

---

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

• src/gams/variables/SearchArea.h