gams::variables::AlgorithmStatus Class Reference

A container for algorithm status information. More...

#include <AlgorithmStatus.h>

Public Member Functions
	AlgorithmStatus ()
	Constructor. More...
	~AlgorithmStatus ()
	Destructor. More...
void	init_variable_values ()
	Initialize variable values. More...
void	init_vars (madara::knowledge::KnowledgeBase &knowledge, const std::string &new_name, const std::string &agent_prefix)
	Initializes variable containers. More...
void	init_vars (madara::knowledge::Variables &knowledge, const std::string &new_name, const std::string &agent_prefix)
	Initializes variable containers. More...
void	init_vars (madara::knowledge::KnowledgeBase &knowledge, const std::string &new_name, int i)
	Initializes variable containers (DEPRECATED) More...
void	init_vars (madara::knowledge::Variables &knowledge, const std::string &new_name, int i)
	Initializes variable containers (DEPRECATED) More...
void	operator= (const AlgorithmStatus &rhs)
	Assignment operator. More...

Public Attributes
madara::knowledge::containers::Integer	deadlocked
	the agent-specific variables More...
madara::knowledge::containers::Integer	failed
	status flag for failed More...
madara::knowledge::containers::Integer	finished
	status flag for finished More...
int	id
	the agent id More...
std::string	name
	the name of the algorithm More...
madara::knowledge::containers::Integer	ok
	status flag for ok More...
madara::knowledge::containers::Integer	paused
	status flag for ok More...
madara::knowledge::containers::Integer	unknown
	status flag for unknown More...
madara::knowledge::containers::Integer	waiting
	status flag for waiting More...

Protected Member Functions
std::string	make_variable_prefix () const
	Get prefix for variables. More...

Detailed Description

A container for algorithm status information.

Definition at line 74 of file AlgorithmStatus.h.

Constructor & Destructor Documentation

gams::variables::AlgorithmStatus::AlgorithmStatus

(

)

Constructor.

gams::variables::AlgorithmStatus::~AlgorithmStatus

(

)

Destructor.

Member Function Documentation

void gams::variables::AlgorithmStatus::init_variable_values

(

)

Initialize variable values.

void gams::variables::AlgorithmStatus::init_vars	(	madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	new_name,
		const std::string &	agent_prefix
	)

Initializes variable containers.

Parameters

knowledge	the knowledge base that houses the variables
new_name	the name of the algorithm
agent_prefix	the agent prefix

void gams::variables::AlgorithmStatus::init_vars	(	madara::knowledge::Variables &	knowledge,
		const std::string &	new_name,
		const std::string &	agent_prefix
	)

Initializes variable containers.

Parameters

knowledge	the knowledge base that houses the variables
new_name	the name of the algorithm
agent_prefix	the agent prefix

void gams::variables::AlgorithmStatus::init_vars	(	madara::knowledge::KnowledgeBase &	knowledge,
		const std::string &	new_name,
		int	i
	)

Initializes variable containers (DEPRECATED)

Parameters

knowledge	the knowledge base that houses the variables
new_name	the name of the algorithm
i	the agent id

void gams::variables::AlgorithmStatus::init_vars	(	madara::knowledge::Variables &	knowledge,
		const std::string &	new_name,
		int	i
	)

Initializes variable containers (DEPRECATED)

Parameters

knowledge	the variable context
new_name	the name of the algorithm
i	the agent id

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

protected

Get prefix for variables.

void gams::variables::AlgorithmStatus::operator=

(

const AlgorithmStatus &

rhs

)

Assignment operator.

Parameters

rhs	value to copy

Member Data Documentation

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

the agent-specific variables

status flag for deadlocked

Definition at line 144 of file AlgorithmStatus.h.

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

status flag for failed

Definition at line 147 of file AlgorithmStatus.h.

madara::knowledge::containers::Integer gams::variables::AlgorithmStatus::finished

status flag for finished

Definition at line 162 of file AlgorithmStatus.h.

int gams::variables::AlgorithmStatus::id

the agent id

Definition at line 135 of file AlgorithmStatus.h.

std::string gams::variables::AlgorithmStatus::name

the name of the algorithm

Definition at line 138 of file AlgorithmStatus.h.

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

status flag for ok

Definition at line 150 of file AlgorithmStatus.h.

madara::knowledge::containers::Integer gams::variables::AlgorithmStatus::paused

status flag for ok

Definition at line 153 of file AlgorithmStatus.h.

madara::knowledge::containers::Integer gams::variables::AlgorithmStatus::unknown

status flag for unknown

Definition at line 156 of file AlgorithmStatus.h.

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

status flag for waiting

Definition at line 159 of file AlgorithmStatus.h.

---

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

• src/gams/variables/AlgorithmStatus.h