gams::variables::PlatformStatus Class Reference

A container for platform status information. More...

#include <PlatformStatus.h>

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

Public Attributes
madara::knowledge::containers::Integer	communication_available
	the agent-specific variables More...
madara::knowledge::containers::Integer	deadlocked
	status flag for deadlocked More...
madara::knowledge::containers::Integer	failed
	status flag for failed More...
madara::knowledge::containers::Integer	gps_spoofed
	status flag for the detection of active spoofing of GPS More...
madara::knowledge::containers::Integer	movement_available
	status flag for full movement availability More...
madara::knowledge::containers::Integer	moving
	status flag for moving to a location More...
std::string	name
	the id of this agent More...
madara::knowledge::containers::Integer	ok
	status flag for ok More...
madara::knowledge::containers::Integer	paused_moving
	status flag for paused while moving to a location More...
madara::knowledge::containers::Integer	paused_rotating
	status flag for paused while rotating to anangle More...
std::string	prefix
	the prefix of the platform status variables in the knowledge base More...
madara::knowledge::containers::Integer	reduced_movement
	status flag for reduced movement available More...
madara::knowledge::containers::Integer	reduced_sensing
	status flag for reduced sensing available More...
madara::knowledge::containers::Integer	rotating
	status flag for rotating to an angle More...
madara::knowledge::containers::Integer	sensors_available
	status flag for full sensor availability More...
madara::knowledge::containers::Integer	waiting
	status flag for waiting More...

Protected Member Functions
void	init_variable_values ()
	Initialize variable values. More...
std::string	make_variable_prefix () const
	Get variable prefix. More...

Detailed Description

A container for platform status information.

Definition at line 73 of file PlatformStatus.h.

Constructor & Destructor Documentation

PlatformStatus()

gams::variables::PlatformStatus::PlatformStatus

(

)

Constructor.

~PlatformStatus()

gams::variables::PlatformStatus::~PlatformStatus

(

)

Destructor.

Member Function Documentation

init_variable_values()

void gams::variables::PlatformStatus::init_variable_values ( )

protected

Initialize variable values.

init_vars() [1/2]

void gams::variables::PlatformStatus::init_vars	(	madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	new_name = ""
	)

Initializes variable containers.

Parameters

knowledge	the knowledge base that houses the variables
new_name	the name of the platform

init_vars() [2/2]

void gams::variables::PlatformStatus::init_vars	(	madara::knowledge::Variables &	knowledge,
		const std::string &	new_name = ""
	)

Initializes variable containers.

Parameters

knowledge	the variable context
new_name	the name of the platform

make_variable_prefix()

std::string gams::variables::PlatformStatus::make_variable_prefix ( ) const

protected

Get variable prefix.

Returns

string variable prefix

operator=()

void gams::variables::PlatformStatus::operator=

(

const PlatformStatus &

rhs

)

Assignment operator.

Parameters

rhs	value to copy

Member Data Documentation

communication_available

madara::knowledge::containers::Integer gams::variables::PlatformStatus::communication_available

the agent-specific variables

status flag for number of communication channels available

Definition at line 118 of file PlatformStatus.h.

deadlocked

madara::knowledge::containers::Integer gams::variables::PlatformStatus::deadlocked

status flag for deadlocked

Definition at line 121 of file PlatformStatus.h.

failed

madara::knowledge::containers::Integer gams::variables::PlatformStatus::failed

status flag for failed

Definition at line 124 of file PlatformStatus.h.

gps_spoofed

madara::knowledge::containers::Integer gams::variables::PlatformStatus::gps_spoofed

status flag for the detection of active spoofing of GPS

Definition at line 127 of file PlatformStatus.h.

movement_available

madara::knowledge::containers::Integer gams::variables::PlatformStatus::movement_available

status flag for full movement availability

Definition at line 130 of file PlatformStatus.h.

moving

madara::knowledge::containers::Integer gams::variables::PlatformStatus::moving

status flag for moving to a location

Definition at line 133 of file PlatformStatus.h.

name

std::string gams::variables::PlatformStatus::name

the id of this agent

Definition at line 109 of file PlatformStatus.h.

ok

madara::knowledge::containers::Integer gams::variables::PlatformStatus::ok

status flag for ok

Definition at line 139 of file PlatformStatus.h.

paused_moving

madara::knowledge::containers::Integer gams::variables::PlatformStatus::paused_moving

status flag for paused while moving to a location

Definition at line 142 of file PlatformStatus.h.

paused_rotating

madara::knowledge::containers::Integer gams::variables::PlatformStatus::paused_rotating

status flag for paused while rotating to anangle

Definition at line 145 of file PlatformStatus.h.

prefix

std::string gams::variables::PlatformStatus::prefix

the prefix of the platform status variables in the knowledge base

Definition at line 112 of file PlatformStatus.h.

reduced_movement

madara::knowledge::containers::Integer gams::variables::PlatformStatus::reduced_movement

status flag for reduced movement available

Definition at line 151 of file PlatformStatus.h.

reduced_sensing

madara::knowledge::containers::Integer gams::variables::PlatformStatus::reduced_sensing

status flag for reduced sensing available

Definition at line 148 of file PlatformStatus.h.

rotating

madara::knowledge::containers::Integer gams::variables::PlatformStatus::rotating

status flag for rotating to an angle

Definition at line 136 of file PlatformStatus.h.

sensors_available

madara::knowledge::containers::Integer gams::variables::PlatformStatus::sensors_available

status flag for full sensor availability

Definition at line 154 of file PlatformStatus.h.

waiting

madara::knowledge::containers::Integer gams::variables::PlatformStatus::waiting

status flag for waiting

Definition at line 157 of file PlatformStatus.h.

---

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

• src/gams/variables/PlatformStatus.h