Fawkes API  Fawkes Development Version
fawkes::CLIPSFeature Class Referenceabstract

#include <>>

Inheritance diagram for fawkes::CLIPSFeature:

Public Member Functions

 CLIPSFeature (const char *feature_name)
 Constructor. More...
 
virtual ~CLIPSFeature ()
 Virtual empty constructor. More...
 
virtual void clips_context_init (const std::string &env_name, fawkes::LockPtr< CLIPS::Environment > &clips)=0
 
virtual void clips_context_destroyed (const std::string &env_name)=0
 

Protected Attributes

const std::string clips_feature_name
 CLIPS feature name. More...
 

Detailed Description

CLIPS feature maintainer. Instances of this class are called to initialize or finalize CLIPS feature requests.

Author
Tim Niemueller

Definition at line 40 of file clips_feature.h.

Constructor & Destructor Documentation

◆ CLIPSFeature()

fawkes::CLIPSFeature::CLIPSFeature ( const char *  feature_name)

Constructor.

Parameters
feature_namename of the feature

Definition at line 45 of file clips_feature.cpp.

◆ ~CLIPSFeature()

fawkes::CLIPSFeature::~CLIPSFeature ( )
virtual

Virtual empty constructor.

Definition at line 50 of file clips_feature.cpp.

References fawkes::Aspect::add_aspect().

Member Function Documentation

◆ clips_context_destroyed()

void fawkes::CLIPSFeature::clips_context_destroyed ( const std::string &  env_name)
pure virtual

Notification that a CLIPS environment has been destroyed. At this time the CLIPS environment can no longer be accessed. But the event can be used to free internal resources that were associated with the environment.

Parameters
env_namename of destroyed CLIPS environment

Implemented in ClipsRobotMemoryThread, ClipsNavGraphThread, ClipsROSThread, BlackboardCLIPSFeature, ClipsProtobufThread, ClipsTFThread, ConfigCLIPSFeature, RedefineWarningCLIPSFeature, and PDDLCLIPSFeature.

◆ clips_context_init()

void fawkes::CLIPSFeature::clips_context_init ( const std::string &  env_name,
fawkes::LockPtr< CLIPS::Environment > &  clips 
)
pure virtual

Initialize a CLIPS context to use the provided feature. This method must be implemented by threads with the CLIPSFeatureAspect. It is called to initialize a particular CLIPS environment that requests to use the provided feature.

Parameters
env_namename of CLIPS environment to initialized.
clipsCLIPS environment to initialize

Implemented in ClipsRobotMemoryThread, ClipsNavGraphThread, ClipsROSThread, BlackboardCLIPSFeature, ClipsProtobufThread, ClipsTFThread, ConfigCLIPSFeature, RedefineWarningCLIPSFeature, and PDDLCLIPSFeature.

Member Data Documentation

◆ clips_feature_name

const std::string fawkes::CLIPSFeature::clips_feature_name
protected

CLIPS feature name.

Definition at line 53 of file clips_feature.h.


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