gams::platforms::PlatformFactory Class Reference

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

#include <PlatformFactory.h>

Inheritance diagram for gams::platforms::PlatformFactory:

Public Member Functions
	PlatformFactory ()
	Constructor. More...
virtual	~PlatformFactory ()
	Destructor. More...
virtual BasePlatform *	create (const madara::knowledge::KnowledgeMap &args, madara::knowledge::KnowledgeBase *knowledge, variables::Sensors *sensors, variables::Platforms *platforms, variables::Self *self)=0
	Creates a platform. 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

Base class for platform factories to create BasePlatforms.

Definition at line 70 of file PlatformFactory.h.

Constructor & Destructor Documentation

PlatformFactory()

gams::platforms::PlatformFactory::PlatformFactory

(

)

Constructor.

~PlatformFactory()

virtual gams::platforms::PlatformFactory::~PlatformFactory ( )

virtual

Destructor.

Member Function Documentation

create()

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

pure virtual

Creates a platform.

Parameters

args	a vector of Knowledge Record arguments
knowledge	the knowledge base to use
sensors	the sensors available
platforms	the status of platforms
self	self-referencing information

Returns

the new platform

Implemented in gams::platforms::PlatformCollectionFactory, gams::platforms::NullPlatformFactory, and gams::platforms::DebugPlatformFactory.

set_knowledge()

void gams::platforms::PlatformFactory::set_knowledge

(

madara::knowledge::KnowledgeBase *

knowledge

)

Sets the knowledge base.

Parameters

knowledge

the knowledge base to use

set_platforms()

void gams::platforms::PlatformFactory::set_platforms

(

variables::Platforms *

platforms

)

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

)

Sets self-referencing variables.

Parameters

self	self-referencing variables

set_sensors()

void gams::platforms::PlatformFactory::set_sensors

(

variables::Sensors *

sensors

)

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_

protected

knowledge base containing variables

Definition at line 129 of file PlatformFactory.h.

platforms_

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

protected

platform variables

Definition at line 132 of file PlatformFactory.h.

self_

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

protected

self-referencing variables

Definition at line 135 of file PlatformFactory.h.

sensors_

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

protected

sensor variables

Definition at line 138 of file PlatformFactory.h.

---

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

• src/gams/platforms/PlatformFactory.h