gams::variables::Region Class Reference

A container for region information. More...

#include <Region.h>

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

Public Attributes
std::string	name
	region identifier More...
madara::knowledge::containers::Integer	type
	the type of region(0 for arbitary convex polygon) More...
std::vector< madara::knowledge::containers::NativeDoubleVector >	vertices
	vertices of the convex polygon More...

Detailed Description

A container for region information.

Definition at line 72 of file Region.h.

Constructor & Destructor Documentation

Region()

gams::variables::Region::Region

(

)

Constructor.

~Region()

gams::variables::Region::~Region

(

)

Destructor.

Member Function Documentation

init_vars() [1/2]

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

Initializes variable containers.

Parameters

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

init_vars() [2/2]

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

Initializes variable containers.

Parameters

knowledge	the variable context
region_name	name of the region

operator=()

void gams::variables::Region::operator=

(

const Region &

rhs

)

Assignment operator.

Parameters

rhs	values to copy

Member Data Documentation

name

std::string gams::variables::Region::name

region identifier

Definition at line 114 of file Region.h.

type

madara::knowledge::containers::Integer gams::variables::Region::type

the type of region(0 for arbitary convex polygon)

Definition at line 108 of file Region.h.

vertices

std::vector<madara::knowledge::containers::NativeDoubleVector> gams::variables::Region::vertices

vertices of the convex polygon

Definition at line 111 of file Region.h.

---

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

• src/gams/variables/Region.h