gams::algorithms Namespace Reference

Provides algorithms and infrastructure for autonomy. More...

Namespaces
	area_coverage
	Provides algorithms specialized in area coverage.
	java
	Provides Java algorithms support.

Classes
class	AlgorithmFactory
	Base class for algorithm factories that classes derived from. More...
class	AlgorithmFactoryRepository
	The controller's algorithm factory. More...
class	AlgorithmMetaData
	A helper class for algorithm information. More...
class	BaseAlgorithm
	The base class that algorithms in GAMS use. More...
class	DebugAlgorithm
	A debug algorithm that prints detailed status information. More...
class	DebugAlgorithmFactory
	A factory class for creating Debug Algorithms. More...
class	Executor
	An algorithm capable of executing other algorithms. More...
class	ExecutorFactory
	A factory class for creating Executor algorithms. More...
class	Follow
	An algorithm for following a target. More...
class	FollowFactory
	A factory class for creating Follow Algorithms. More...
class	FormationCoverage
	An algorithm for covering an area in formation. More...
class	FormationCoverageFactory
	A factory class for creating Formation Coverage algorithms. More...
class	FormationFlying
	An algorithm for moving in formation. More...
class	FormationFlyingFactory
	A factory class for creating Formation Flying algorithms. More...
class	FormationSync
	An algorithm for covering an area in formation with a synchronous model of computation. More...
class	FormationSyncFactory
	A factory class for creating Formation Coverage algorithms. More...
class	Greet
	An algorithm for greeting a target if it comes within range and potentially following the target around. More...
class	GreetFactory
	A factory class for creating Greet Algorithms. More...
class	GroupBarrier
	An algorithm for covering an area in formation with a synchronous model of computation. More...
class	GroupBarrierFactory
	A factory class for creating Formation Coverage algorithms. More...
class	Hold
	An algorithm for taking off. More...
class	HoldFactory
	A factory class for creating Null algorithms. More...
class	Home
	An algorithm for taking off. More...
class	HomeFactory
	A factory class for creating Null algorithms. More...
class	JavaAlgorithm
	A facade for Java algorithms. More...
class	JavaAlgorithmFactory
	A factory class for creating Java Algorithms. More...
class	KarlEvaluator
	An algorithm capable of executing other algorithms. More...
class	KarlEvaluatorFactory
	A factory class for creating KarlEvaluator algorithms. More...
class	Land
	An algorithm for landing. More...
class	LandFactory
	A factory class for creating Landing algorithms. More...
class	MessageProfiling
	An algorithm for profiling message generation and receipt. More...
class	MessageProfilingFactory
	A factory class for creating MessageProfiling Algorithms. More...
class	Move
	An algorithm for moving to a location. More...
class	MoveFactory
	A factory class for creating Move algorithms. More...
class	NullAlgorithm
	An algorithm that performs no-ops for all methods. More...
class	NullAlgorithmFactory
	A factory class for creating Null algorithms. More...
class	PerformanceProfiling
	An algorithm for testing computational speed. More...
class	PerformanceProfilingFactory
	A factory class for creating PerformanceProfiling Algorithms. More...
class	PerimeterPatrol
	An algorithm for patrolling a region. More...
class	PerimeterPatrolFactory
	A factory class for creating PerimeterPatrol algorithms. More...
class	Spell
class	SpellFactory
	A factory class for creating Spell algorithms. More...
class	Takeoff
	An algorithm for taking off. More...
class	TakeoffFactory
	A factory class for creating Null algorithms. More...
class	Wait
	An algorithm for waiting. More...
class	WaitFactory
	A factory class for creating Wait algorithms. More...
class	ZoneCoverage
	An algorithm for covering an area in formation with a synchronous model of computation. More...
class	ZoneCoverageFactory
	A factory class for creating Formation Coverage algorithms. More...

Typedefs
typedef std::map< std::string, AlgorithmFactory * >	AlgorithmFactoryMap
	Convenience typedef for a map of aliases to factories. More...
typedef std::vector< AlgorithmMetaData >	AlgorithmMetaDatas
	helper typdef for collection of AlgorithMetaData More...
typedef std::vector< BaseAlgorithm * >	Algorithms
typedef BaseAlgorithm	Base

Enumerations
enum	AlgorithmAnalyzeStatus {   UNKNOWN = 0x00000000 , OK = 0x00000001 , WAITING = 0x00000002 , DEADLOCKED = 0x00000004 ,   FAILED = 0x00000008 , FINISHED = 0x00000010 }
	Possible algorithm statuses, as returnable by analyze() More...

Functions
GAMS_EXPORT AlgorithmFactoryRepository *	global_algorithm_factory ()
	A globally accessible algorithm factory. More...

Detailed Description

Provides algorithms and infrastructure for autonomy.

Typedef Documentation

AlgorithmFactoryMap

typedef std::map<std::string, AlgorithmFactory *> gams::algorithms::AlgorithmFactoryMap

Convenience typedef for a map of aliases to factories.

Definition at line 74 of file AlgorithmFactoryRepository.h.

AlgorithmMetaDatas

typedef std::vector<AlgorithmMetaData> gams::algorithms::AlgorithmMetaDatas

helper typdef for collection of AlgorithMetaData

Definition at line 91 of file Executor.h.

Algorithms

typedef std::vector<BaseAlgorithm *> gams::algorithms::Algorithms

Definition at line 225 of file BaseAlgorithm.h.

Base

typedef BaseAlgorithm gams::algorithms::Base

Definition at line 223 of file BaseAlgorithm.h.

Enumeration Type Documentation

AlgorithmAnalyzeStatus

enum gams::algorithms::AlgorithmAnalyzeStatus

Possible algorithm statuses, as returnable by analyze()

Enumerator
UNKNOWN
OK
WAITING
DEADLOCKED
FAILED
FINISHED

Definition at line 81 of file BaseAlgorithm.h.

Function Documentation

global_algorithm_factory()

GAMS_EXPORT AlgorithmFactoryRepository* gams::algorithms::global_algorithm_factory

(

)

A globally accessible algorithm factory.

The algorithm factory should have all new algorithms added to it before new threads that might access the factory are started. This is not currently thread safe.