GAMS  1.4.0
gams::groups::GroupFactory Class Referenceabstract

Base class for a group factory. More...

#include <GroupFactory.h>

Inheritance diagram for gams::groups::GroupFactory:
gams::groups::GroupFixedListFactory gams::groups::GroupTransientFactory

Public Member Functions

 GroupFactory ()
 Constructor. More...
 
virtual ~GroupFactory ()
 Destructor. More...
 
virtual GroupBasecreate (const std::string &prefix, madara::knowledge::KnowledgeBase *knowledge)=0
 Creates a group. More...
 
void set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
 Sets the knowledge base. More...
 

Protected Attributes

madara::knowledge::KnowledgeBase * knowledge_
 knowledge base containing variables More...
 

Detailed Description

Base class for a group factory.

Definition at line 71 of file GroupFactory.h.

Constructor & Destructor Documentation

◆ GroupFactory()

gams::groups::GroupFactory::GroupFactory ( )

Constructor.

◆ ~GroupFactory()

virtual gams::groups::GroupFactory::~GroupFactory ( )
virtual

Destructor.

Member Function Documentation

◆ create()

virtual GroupBase* gams::groups::GroupFactory::create ( const std::string &  prefix,
madara::knowledge::KnowledgeBase *  knowledge 
)
pure virtual

Creates a group.

Parameters
prefixthe name of the group(e.g. group.protectors)
knowledgethe knowledge base of variables and values
Returns
the new group

Implemented in gams::groups::GroupTransientFactory, and gams::groups::GroupFixedListFactory.

◆ set_knowledge()

void gams::groups::GroupFactory::set_knowledge ( madara::knowledge::KnowledgeBase *  knowledge)

Sets the knowledge base.

Parameters
knowledgethe knowledge base to use

Member Data Documentation

◆ knowledge_

madara::knowledge::KnowledgeBase* gams::groups::GroupFactory::knowledge_
protected

knowledge base containing variables

Definition at line 103 of file GroupFactory.h.


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