A helper class for prioritized region information. More...

#include <PrioritizedRegion.h>

Inheritance diagram for gams::pose::PrioritizedRegion:

Public Member Functions
	PrioritizedRegion (const Region &region, const unsigned int new_priority=1, const std::string &name="")
	Constructor. More...

	PrioritizedRegion (const std::vector< Position > &init_points=std::vector< Position >(), const unsigned int new_priority=1, const std::string &name="")
	Constructor. More...

virtual	~PrioritizedRegion ()
	Destructor. More...

bool	contains (const Position &position) const
	Determines if GPSPosition is in region. More...

double	distance (const Position &position) const
	Gets distance from any point in this region. More...

bool	from_container (const std::string &name="")
	Load object from knowledge base. More...

bool	from_container (madara::knowledge::KnowledgeBase &kb, const std::string &name="")
	Load object from knowledge base. More...

double	get_area () const
	Gets area of the region. More...

Region	get_bounding_box () const
	Gets bounding box. More...

std::string	get_name () const
	Gets name of region. More...

void	modify ()
	Resend the information in the container using same knowledge base as previous to_container. More...

bool	operator!= (const PrioritizedRegion &rhs) const
	Inequality operator. More...

bool	operator!= (const Region &rhs) const
	Inequality operator. More...

void	operator= (const PrioritizedRegion &rhs)
	Assignment operator. More...

bool	operator== (const PrioritizedRegion &rhs) const
	Equality operator. More...

bool	operator== (const Region &rhs) const
	Equality operator. More...

void	set_knowledge_base (madara::knowledge::KnowledgeBase *kb)
	Set knowledge base to use. More...

void	set_name (const std::string &name)
	Sets name of region. More...

void	to_container (const std::string &name="")
	Store object in knowledge base used previously. More...

void	to_container (madara::knowledge::KnowledgeBase &kb, const std::string &name="")
	Store object in knowledge base. More...

std::string	to_string (const std::string &delimiter=":") const
	Helper function for converting the position to a string. More...

Public Attributes
double	max_alt_

double	max_lat_

double	max_lon_

double	min_alt_

double	min_lat_
	bounding box More...

double	min_lon_

madara::knowledge::KnowledgeRecord::Integer	priority
	priority More...

std::vector< Position >	vertices
	the vertices of the region More...

Protected Types
enum	Class_ID { REGION_TYPE_ID = 0x00000001 , PRIORITIZED_REGION_TYPE_ID = 0x00000002 , SEARCH_AREA_TYPE_ID = 0x00000004 , INVALID = 0x80000000 }
	These are used to check on the type of the object in from_container. More...

Protected Member Functions
void	calculate_bounding_box ()
	populate bounding box values More...

bool	is_valid_type (madara::knowledge::KnowledgeBase &kb, const std::string &name, const Class_ID &expected) const
	Check if the type is correct. More...

Static Protected Member Functions
static Class_ID	get_type (madara::knowledge::KnowledgeBase &kb, const std::string &name)
	Gets type of object in database. More...

Protected Attributes
std::string	name_
	name of this object More...

madara::knowledge::KnowledgeBase *	prev_kb_
	previous knowledge base used for sending objects More...

unsigned int	type_
	type for this region More...

Static Protected Attributes
static const std::string	object_type_suffix_
	object type suffix More...

Private Member Functions
virtual bool	check_valid_type (madara::knowledge::KnowledgeBase &kb, const std::string &name) const
	Check if object is of correct type. More...

virtual bool	from_container_impl (madara::knowledge::KnowledgeBase &kb, const std::string &name)
	Load object from knowledge base. More...

virtual void	to_container_impl (madara::knowledge::KnowledgeBase &kb, const std::string &name)
	Store object in knowledge base. More...

Detailed Description

A helper class for prioritized region information.

Definition at line 72 of file PrioritizedRegion.h.

Member Enumeration Documentation

◆ Class_ID

enum gams::utility::Containerize::Class_ID

protectedinherited

These are used to check on the type of the object in from_container.

When inheriting from this class, add your new class to this list to check for your unique ID. Assign this value in the knowledge base to "prefix + object_type_suffix"

Enumerator
REGION_TYPE_ID
PRIORITIZED_REGION_TYPE_ID
SEARCH_AREA_TYPE_ID
INVALID

Definition at line 154 of file Containerize.h.

Constructor & Destructor Documentation

◆ PrioritizedRegion() [1/2]

gams::pose::PrioritizedRegion::PrioritizedRegion	(	const std::vector< Position > &	init_points = `std::vector< Position >()`,
		const unsigned int	new_priority = `1`,
		const std::string &	name = `""`
	)

Constructor.

Parameters

init_points	vector of points representing boundary polygon of region
new_priority	associated priority
name	name of the region

◆ PrioritizedRegion() [2/2]

gams::pose::PrioritizedRegion::PrioritizedRegion	(	const Region &	region,
		const unsigned int	new_priority = `1`,
		const std::string &	name = `""`
	)

Constructor.

Parameters

region	associated region
new_priority	associated priority
name	name of the region

◆ ~PrioritizedRegion()

virtual gams::pose::PrioritizedRegion::~PrioritizedRegion ( )

virtual

Destructor.

Member Function Documentation

◆ calculate_bounding_box()

void gams::pose::Region::calculate_bounding_box ( )

protectedinherited

populate bounding box values

◆ check_valid_type()

virtual bool gams::pose::PrioritizedRegion::check_valid_type	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name
	)		const

privatevirtual

Check if object is of correct type.

Parameters

kb	Knowledge Base with object
name	Prefix of object in the KB

Reimplemented from gams::pose::Region.

◆ contains()

bool gams::pose::Region::contains ( const Position & position ) const

inherited

Determines if GPSPosition is in region.

Parameters

position point to check if in region

Returns: true if point is in region or on border, false otherwise

◆ distance()

double gams::pose::Region::distance ( const Position & position ) const

inherited

Gets distance from any point in this region.

Parameters

position point to check

Returns: 0 if in region, otherwise distance from region

◆ from_container() [1/2]

bool gams::utility::Containerize::from_container ( const std::string & name = "" )

inherited

Load object from knowledge base.

Parameters

name	location of object in Knowlege Base

Returns: true if object successfully loaded from knowledge base

◆ from_container() [2/2]

bool gams::utility::Containerize::from_container	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name = `""`
	)

inherited

Load object from knowledge base.

Parameters

kb	Knowledge Base with object
name	location of object in Knowlege Base

Returns: true if object successfully loaded from knowledge base

◆ from_container_impl()

virtual bool gams::pose::PrioritizedRegion::from_container_impl	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name
	)

privatevirtual

Load object from knowledge base.

Parameters

kb	Knowledge Base with object
name	location of object in Knowlege Base

Reimplemented from gams::pose::Region.

◆ get_area()

double gams::pose::Region::get_area ( ) const

inherited

Gets area of the region.

Returns: area of this region

◆ get_bounding_box()

Region gams::pose::Region::get_bounding_box ( ) const

inherited

Gets bounding box.

Returns: Region object corresponding to bounding box

◆ get_name()

std::string gams::pose::Region::get_name ( ) const

inherited

Gets name of region.

Returns: name of the region

◆ get_type()

static Class_ID gams::utility::Containerize::get_type	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name
	)

staticprotectedinherited

Gets type of object in database.

Parameters

kb	Knowledge Base with object
name	Prefix of object in the KB

Returns: Class_ID of object in kb

◆ is_valid_type()

bool gams::utility::Containerize::is_valid_type	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name,
		const Class_ID &	expected
	)		const

protectedinherited

Check if the type is correct.

Parameters

kb	Knowledge Base with object
name	Prefix of object in the KB
expected	Expected value

Returns: true if correct type, false otherwise

◆ modify()

void gams::utility::Containerize::modify ( )

inherited

Resend the information in the container using same knowledge base as previous to_container.

◆ operator!=() [1/2]

bool gams::pose::PrioritizedRegion::operator!= ( const PrioritizedRegion & rhs ) const

Inequality operator.

Uses operator== and inverses result

Parameters

rhs	PrioritizedRegion to compare to

Returns: false if same vertices and same priority, true otherwise

◆ operator!=() [2/2]

bool gams::pose::Region::operator!= ( const Region & rhs ) const

inherited

Inequality operator.

Calls operator== and inverses result

Parameters

rhs	Region to compare with

◆ operator=()

void gams::pose::PrioritizedRegion::operator= ( const PrioritizedRegion & rhs )

Assignment operator.

Parameters

rhs	values to copy

◆ operator==() [1/2]

bool gams::pose::PrioritizedRegion::operator== ( const PrioritizedRegion & rhs ) const

Equality operator.

Uses Region::operator== and checks if priority are equal

Parameters

rhs	PrioritizedRegion to compare to

Returns: true if same vertices and same priority, false otherwise

◆ operator==() [2/2]

bool gams::pose::Region::operator== ( const Region & rhs ) const

inherited

Equality operator.

Only checks if the vertices are the same

Parameters

rhs	Region to compare with

◆ set_knowledge_base()

void gams::utility::Containerize::set_knowledge_base ( madara::knowledge::KnowledgeBase * kb )

inherited

Set knowledge base to use.

◆ set_name()

void gams::pose::Region::set_name ( const std::string & name )

inherited

Sets name of region.

Parameters

name	new name of the region

◆ to_container() [1/2]

void gams::utility::Containerize::to_container ( const std::string & name = "" )

inherited

Store object in knowledge base used previously.

Parameters

name	location of object in Knowlege Base

◆ to_container() [2/2]

void gams::utility::Containerize::to_container	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name = `""`
	)

inherited

Store object in knowledge base.

Parameters

kb	Knowledge Base to store object in
name	location of object in Knowlege Base

◆ to_container_impl()

virtual void gams::pose::PrioritizedRegion::to_container_impl	(	madara::knowledge::KnowledgeBase &	kb,
		const std::string &	name
	)

privatevirtual

Store object in knowledge base.

Parameters

kb	Knowledge Base to store object in
name	location of object in Knowlege Base

Reimplemented from gams::pose::Region.

◆ to_string()

std::string gams::pose::PrioritizedRegion::to_string ( const std::string & delimiter = ":" ) const

Helper function for converting the position to a string.

Parameters

delimiter characters to insert between position components

Returns: string representation of this PrioritizedRegion

Member Data Documentation

◆ max_alt_

double gams::pose::Region::max_alt_

inherited

Definition at line 171 of file Region.h.

◆ max_lat_

double gams::pose::Region::max_lat_

inherited

Definition at line 169 of file Region.h.

◆ max_lon_

double gams::pose::Region::max_lon_

inherited

Definition at line 170 of file Region.h.

◆ min_alt_

double gams::pose::Region::min_alt_

inherited

Definition at line 171 of file Region.h.

◆ min_lat_

double gams::pose::Region::min_lat_

inherited

bounding box

Definition at line 169 of file Region.h.

◆ min_lon_

double gams::pose::Region::min_lon_

inherited

Definition at line 170 of file Region.h.

◆ name_

std::string gams::utility::Containerize::name_

protectedinherited

name of this object

Definition at line 143 of file Containerize.h.

◆ object_type_suffix_

const std::string gams::utility::Containerize::object_type_suffix_

staticprotectedinherited

object type suffix

Definition at line 140 of file Containerize.h.

◆ prev_kb_

madara::knowledge::KnowledgeBase* gams::utility::Containerize::prev_kb_

protectedinherited

previous knowledge base used for sending objects

Definition at line 146 of file Containerize.h.

◆ priority

madara::knowledge::KnowledgeRecord::Integer gams::pose::PrioritizedRegion::priority

priority

Definition at line 127 of file PrioritizedRegion.h.

◆ type_

unsigned int gams::pose::Region::type_

protectedinherited

type for this region

Definition at line 180 of file Region.h.

◆ vertices

std::vector<Position> gams::pose::Region::vertices

inherited

the vertices of the region

Definition at line 166 of file Region.h.

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

src/gams/pose/PrioritizedRegion.h

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ Class_ID

Constructor & Destructor Documentation

◆ PrioritizedRegion() [1/2]

◆ PrioritizedRegion() [2/2]

◆ ~PrioritizedRegion()

Member Function Documentation

◆ calculate_bounding_box()

◆ check_valid_type()

◆ contains()

◆ distance()

◆ from_container() [1/2]

◆ from_container() [2/2]

◆ from_container_impl()

◆ get_area()

◆ get_bounding_box()

◆ get_name()

◆ get_type()

◆ is_valid_type()

◆ modify()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ set_knowledge_base()

◆ set_name()

◆ to_container() [1/2]

◆ to_container() [2/2]

◆ to_container_impl()

◆ to_string()

Member Data Documentation

◆ max_alt_

◆ max_lat_

◆ max_lon_

◆ min_alt_

◆ min_lat_

◆ min_lon_

◆ name_

◆ object_type_suffix_

◆ prev_kb_

◆ priority

◆ type_

◆ vertices