gams::platforms::PlatformCollectionFactory Class Reference

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

#include <PlatformCollection.h>

Inheritance diagram for gams::platforms::PlatformCollectionFactory:

Public Member Functions
virtual BasePlatform *	create (const madara::knowledge::KnowledgeMap &args, madara::knowledge::KnowledgeBase *knowledge, variables::Sensors *sensors, variables::Platforms *platforms, variables::Self *self)
	Creates a platform collection. More...
void	set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
	Sets the knowledge base. More...
void	set_platforms (variables::Platforms *platforms)
	Sets the map of platform names to platform information. More...
void	set_self (variables::Self *self)
	Sets self-referencing variables. More...
void	set_sensors (variables::Sensors *sensors)
	Sets the map of sensor names to sensor information. More...

Protected Attributes
madara::knowledge::KnowledgeBase *	knowledge_
	knowledge base containing variables More...
variables::Platforms *	platforms_
	platform variables More...
variables::Self *	self_
	self-referencing variables More...
variables::Sensors *	sensors_
	sensor variables More...

Detailed Description

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

Definition at line 174 of file PlatformCollection.h.

Member Function Documentation

create()

virtual BasePlatform* gams::platforms::PlatformCollectionFactory::create ( const madara::knowledge::KnowledgeMap &  args, madara::knowledge::KnowledgeBase *  knowledge, variables::Sensors *  sensors, variables::Platforms *  platforms, variables::Self *  self  )

virtual

Creates a platform collection.

Parameters

args	no arguments are necessary for this platform
knowledge	the knowledge base. This will be set by the controller in init_vars.
sensors	the sensor info. This will be set by the controller in init_vars.
platforms	status inform for all known agents. This will be set by the controller in init_vars
self	self-referencing variables. This will be set by the controller in init_vars

Implements gams::platforms::PlatformFactory.

set_knowledge()

void gams::platforms::PlatformFactory::set_knowledge ( madara::knowledge::KnowledgeBase *  knowledge )

inherited

Sets the knowledge base.

Parameters

knowledge

the knowledge base to use

set_platforms()

void gams::platforms::PlatformFactory::set_platforms ( variables::Platforms *  platforms )

inherited

Sets the map of platform names to platform information.

Parameters

platforms

map of platform names to platform information

set_self()

void gams::platforms::PlatformFactory::set_self ( variables::Self *  self )

inherited

Sets self-referencing variables.

Parameters

self	self-referencing variables

set_sensors()

void gams::platforms::PlatformFactory::set_sensors ( variables::Sensors *  sensors )

inherited

Sets the map of sensor names to sensor information.

Parameters

sensors

map of sensor names to sensor information

Member Data Documentation

knowledge_

madara::knowledge::KnowledgeBase* gams::platforms::PlatformFactory::knowledge_

protectedinherited

knowledge base containing variables

Definition at line 129 of file PlatformFactory.h.

platforms_

variables::Platforms* gams::platforms::PlatformFactory::platforms_

protectedinherited

platform variables

Definition at line 132 of file PlatformFactory.h.

self_

variables::Self* gams::platforms::PlatformFactory::self_

protectedinherited

self-referencing variables

Definition at line 135 of file PlatformFactory.h.

sensors_

variables::Sensors* gams::platforms::PlatformFactory::sensors_

protectedinherited

sensor variables

Definition at line 138 of file PlatformFactory.h.

---

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

• src/gams/platforms/PlatformCollection.h