Provides platform abstractions for hardware and simulations. More...

Namespaces
	dronerk
	Provides bindings to Drone-RK (no longer supported)

	java
	Provides infrastructure for Java-based platforms.

	ros
	Provides infrastructure for ROS-based platforms.

	vrep
	Provides infrastructure for VREP-based platforms.

Classes
class	BasePlatform
	The base platform for all platforms to use. More...

class	DebugPlatform
	A debug platform that prints detailed status information. More...

class	DebugPlatformFactory
	A factory class for creating debug platforms. More...

class	JavaPlatform
	A facade for Java platforms. More...

class	NullPlatform
	A null platform. More...

class	NullPlatformFactory
	A factory class for creating null(no-op) platforms. More...

class	PlatformCollection
	A collection of platforms. More...

class	PlatformCollectionFactory
	A factory class for creating null(no-op) platforms. More...

class	PlatformFactory
	Base class for platform factories to create BasePlatforms. More...

class	PlatformFactoryRepository
	The controller's platform factory. More...

Typedefs
typedef BasePlatform	Base

typedef std::map< std::string, PlatformFactory * >	FactoryMap

Enumerations
enum	PlatformAnalyzeStatus { UNKNOWN = 0 , OK = 1 , WAITING = 2 , DEADLOCKED = 4 , FAILED = 8 , MOVING = 16 , REDUCED_SENSING_AVAILABLE = 128 , REDUCED_MOVEMENT_AVAILABLE = 256 , COMMUNICATION_AVAILABLE = 512 , SENSORS_AVAILABLE = 1024 , MOVEMENT_AVAILABLE = 2048 }
	Possible platform statuses, as returnable by analyze() More...

enum	PlatformReturnValues { PLATFORM_ERROR = 0 , PLATFORM_IN_PROGRESS = 1 , PLATFORM_MOVING = 1 , PLATFORM_OK = 1 , PLATFORM_ARRIVED = 2 }
	Platform return values. More...

Functions
GAMS_EXPORT PlatformFactoryRepository *	global_platform_factory ()
	A globally accessible platform factory. More...

Detailed Description

Provides platform abstractions for hardware and simulations.

Typedef Documentation

◆ Base

typedef BasePlatform gams::platforms::Base

Definition at line 455 of file BasePlatform.h.

◆ FactoryMap

typedef std::map<std::string, PlatformFactory *> gams::platforms::FactoryMap

Definition at line 70 of file PlatformFactoryRepository.h.

Enumeration Type Documentation

◆ PlatformAnalyzeStatus

enum gams::platforms::PlatformAnalyzeStatus

Possible platform statuses, as returnable by analyze()

Enumerator
UNKNOWN
OK
WAITING
DEADLOCKED
FAILED
MOVING
REDUCED_SENSING_AVAILABLE
REDUCED_MOVEMENT_AVAILABLE
COMMUNICATION_AVAILABLE
SENSORS_AVAILABLE
MOVEMENT_AVAILABLE

Definition at line 82 of file BasePlatform.h.

◆ PlatformReturnValues

enum gams::platforms::PlatformReturnValues

Platform return values.

Enumerator
PLATFORM_ERROR
PLATFORM_IN_PROGRESS
PLATFORM_MOVING
PLATFORM_OK
PLATFORM_ARRIVED

Definition at line 100 of file BasePlatform.h.

Function Documentation

◆ global_platform_factory()

GAMS_EXPORT PlatformFactoryRepository* gams::platforms::global_platform_factory ( )

A globally accessible platform factory.

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

Namespaces

Classes

Typedefs

Enumerations

Functions