A facade for Java algorithms. More...

#include <JavaAlgorithm.h>

Inheritance diagram for gams::algorithms::JavaAlgorithm:

Public Member Functions
	JavaAlgorithm (jobject obj, madara::knowledge::KnowledgeBase knowledge=0, platforms::BasePlatform platform=0, variables::Sensors sensors=0, variables::Self self=0, variables::Agents *agents=0)
	Constructor. More...

	~JavaAlgorithm ()
	Destructor. More...

virtual int	analyze (void)
	Analyzes environment, platform, or other information. More...

virtual int	execute (void)
	Plans the next execution of the algorithm. More...

variables::Agents *	get_agents (void)
	Gets the list of agents. More...

variables::AlgorithmStatus *	get_algorithm_status (void)
	Gets algorithm status variables. More...

virtual std::string	get_id () const
	Gets the unique identifier of the algorithm. More...

jobject	get_java_instance (void)
	Returns the Java instance that derives from BaseAlgorithm. More...

madara::knowledge::KnowledgeBase *	get_knowledge_base (void)
	Gets the knowledge base. More...

virtual std::string	get_name () const
	Gets the name of the algorithm. More...

platforms::BasePlatform *	get_platform (void)
	Gets the platform. More...

variables::Self *	get_self (void)
	Gets self-defined variables. More...

variables::Sensors *	get_sensors (void)
	Gets the available sensor information. More...

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

virtual int	plan (void)
	Plans the next execution of the algorithm. More...

virtual void	set_agents (variables::Agents *agents)
	Sets the list of agents in the swarm. More...

virtual void	set_platform (platforms::BasePlatform *platform)
	Sets the platform. More...

virtual void	set_self (variables::Self *self)
	Sets the map of sensor names to sensor information. More...

virtual void	set_sensors (variables::Sensors *sensors)
	Sets the map of sensor names to sensor information. More...

Protected Attributes
variables::Agents *	agents_
	the list of agents potentially participating in the algorithm More...

jclass	class_
	the class of the Java object obj_ More...

unsigned int	executions_
	number of executions More...

madara::knowledge::KnowledgeBase *	knowledge_
	provides access to the knowledge base More...

jobject	obj_
	the Java object with callable methods More...

platforms::BasePlatform *	platform_
	provides access to the platform More...

variables::Self *	self_
	the algorithm's concept of self More...

variables::Sensors *	sensors_
	provides access to sensor information More...

variables::AlgorithmStatus	status_
	provides access to status information for this platform More...

Detailed Description

A facade for Java algorithms.

Definition at line 77 of file JavaAlgorithm.h.

Constructor & Destructor Documentation

◆ JavaAlgorithm()

gams::algorithms::JavaAlgorithm::JavaAlgorithm	(	jobject	obj,
		madara::knowledge::KnowledgeBase *	knowledge = `0`,
		platforms::BasePlatform *	platform = `0`,
		variables::Sensors *	sensors = `0`,
		variables::Self *	self = `0`,
		variables::Agents *	agents = `0`
	)

Constructor.

Parameters

obj	the Java object to call methods on
knowledge	knowledge base
platform	the platform to use
sensors	map of sensor names to sensor information
self	agent variables that describe self state
agents	list of participating agents

◆ ~JavaAlgorithm()

gams::algorithms::JavaAlgorithm::~JavaAlgorithm ( )

Destructor.

Member Function Documentation

◆ analyze()

virtual int gams::algorithms::JavaAlgorithm::analyze ( void )

virtual

Analyzes environment, platform, or other information.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ execute()

virtual int gams::algorithms::JavaAlgorithm::execute ( void )

virtual

Plans the next execution of the algorithm.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ get_agents()

variables::Agents* gams::algorithms::BaseAlgorithm::get_agents ( void )

inherited

Gets the list of agents.

◆ get_algorithm_status()

variables::AlgorithmStatus* gams::algorithms::BaseAlgorithm::get_algorithm_status ( void )

inherited

Gets algorithm status variables.

◆ get_id()

virtual std::string gams::algorithms::JavaAlgorithm::get_id ( ) const

virtual

Gets the unique identifier of the algorithm.

This should be an alphanumeric identifier that can be used as part of a MADARA variable(e.g. rac, follow_leader, etc.)

◆ get_java_instance()

jobject gams::algorithms::JavaAlgorithm::get_java_instance ( void )

Returns the Java instance that derives from BaseAlgorithm.

◆ get_knowledge_base()

madara::knowledge::KnowledgeBase* gams::algorithms::BaseAlgorithm::get_knowledge_base ( void )

inherited

Gets the knowledge base.

◆ get_name()

virtual std::string gams::algorithms::JavaAlgorithm::get_name ( ) const

virtual

Gets the name of the algorithm.

◆ get_platform()

platforms::BasePlatform* gams::algorithms::BaseAlgorithm::get_platform ( void )

inherited

Gets the platform.

◆ get_self()

variables::Self* gams::algorithms::BaseAlgorithm::get_self ( void )

inherited

Gets self-defined variables.

◆ get_sensors()

variables::Sensors* gams::algorithms::BaseAlgorithm::get_sensors ( void )

inherited

Gets the available sensor information.

◆ operator=()

void gams::algorithms::JavaAlgorithm::operator= ( const JavaAlgorithm & rhs )

Assignment operator.

Parameters

rhs	values to copy

◆ plan()

virtual int gams::algorithms::JavaAlgorithm::plan ( void )

virtual

Plans the next execution of the algorithm.

Returns: bitmask status of the platform.

See also: Status.

Implements gams::algorithms::BaseAlgorithm.

◆ set_agents()

virtual void gams::algorithms::BaseAlgorithm::set_agents ( variables::Agents * agents )

virtualinherited

Sets the list of agents in the swarm.

Parameters

agents list of agents

◆ set_platform()

virtual void gams::algorithms::BaseAlgorithm::set_platform ( platforms::BasePlatform * platform )

virtualinherited

Sets the platform.

Parameters

platform the underlying platform the algorithm will use

◆ set_self()

virtual void gams::algorithms::BaseAlgorithm::set_self ( variables::Self * self )

virtualinherited

Sets the map of sensor names to sensor information.

Parameters

self	pointer to self-referencing variables container

◆ set_sensors()

virtual void gams::algorithms::BaseAlgorithm::set_sensors ( variables::Sensors * sensors )

virtualinherited

Sets the map of sensor names to sensor information.

Parameters

sensors map of sensor names to sensor information

Member Data Documentation

◆ agents_

variables::Agents* gams::algorithms::BaseAlgorithm::agents_

protectedinherited

the list of agents potentially participating in the algorithm

Definition at line 201 of file BaseAlgorithm.h.

◆ class_

jclass gams::algorithms::JavaAlgorithm::class_

protected

the class of the Java object obj_

Definition at line 149 of file JavaAlgorithm.h.

◆ executions_

unsigned int gams::algorithms::BaseAlgorithm::executions_

protectedinherited

number of executions

Definition at line 204 of file BaseAlgorithm.h.

◆ knowledge_

madara::knowledge::KnowledgeBase* gams::algorithms::BaseAlgorithm::knowledge_

protectedinherited

provides access to the knowledge base

Definition at line 207 of file BaseAlgorithm.h.

◆ obj_

jobject gams::algorithms::JavaAlgorithm::obj_

protected

the Java object with callable methods

Definition at line 146 of file JavaAlgorithm.h.

◆ platform_

platforms::BasePlatform* gams::algorithms::BaseAlgorithm::platform_

protectedinherited

provides access to the platform

Definition at line 210 of file BaseAlgorithm.h.

◆ self_

variables::Self* gams::algorithms::BaseAlgorithm::self_

protectedinherited

the algorithm's concept of self

Definition at line 213 of file BaseAlgorithm.h.

◆ sensors_

variables::Sensors* gams::algorithms::BaseAlgorithm::sensors_

protectedinherited

provides access to sensor information

Definition at line 216 of file BaseAlgorithm.h.

◆ status_

variables::AlgorithmStatus gams::algorithms::BaseAlgorithm::status_

protectedinherited

provides access to status information for this platform

Definition at line 219 of file BaseAlgorithm.h.

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

src/gams/algorithms/java/JavaAlgorithm.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JavaAlgorithm()

◆ ~JavaAlgorithm()

Member Function Documentation

◆ analyze()

◆ execute()

◆ get_agents()

◆ get_algorithm_status()

◆ get_id()

◆ get_java_instance()

◆ get_knowledge_base()

◆ get_name()

◆ get_platform()

◆ get_self()

◆ get_sensors()

◆ operator=()

◆ plan()

◆ set_agents()

◆ set_platform()

◆ set_self()

◆ set_sensors()

Member Data Documentation

◆ agents_

◆ class_

◆ executions_

◆ knowledge_

◆ obj_

◆ platform_

◆ self_

◆ sensors_

◆ status_