Fawkes API  Fawkes Development Version
BlackboardCLIPSFeature Class Reference

#include "feature_blackboard.h"

Inheritance diagram for BlackboardCLIPSFeature:

Public Member Functions

 BlackboardCLIPSFeature (fawkes::Logger *logger, fawkes::BlackBoard *blackboard, bool retract_early)
 Constructor. More...
 
virtual ~BlackboardCLIPSFeature ()
 Destructor. More...
 
virtual void clips_context_init (const std::string &env_name, fawkes::LockPtr< CLIPS::Environment > &clips)
 
virtual void clips_context_destroyed (const std::string &env_name)
 
- Public Member Functions inherited from fawkes::CLIPSFeature
 CLIPSFeature (const char *feature_name)
 Constructor. More...
 
virtual ~CLIPSFeature ()
 Virtual empty constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from fawkes::CLIPSFeature
const std::string clips_feature_name
 CLIPS feature name. More...
 

Detailed Description

CLIPS blackboard feature.

Author
Tim Niemueller

Definition at line 44 of file feature_blackboard.h.

Constructor & Destructor Documentation

◆ BlackboardCLIPSFeature()

BlackboardCLIPSFeature::BlackboardCLIPSFeature ( fawkes::Logger logger,
fawkes::BlackBoard blackboard,
bool  retract_early 
)

Constructor.

Parameters
loggermessage logger
blackboardblackboard to use for opening interfaces
retract_earlyRetract blackboard facts at the end of the same execution cycle they have been asserted in. If false (default), blackboard facts are only retracted immediately before a new fact representing a particular interface is asserted.

Definition at line 50 of file feature_blackboard.cpp.

◆ ~BlackboardCLIPSFeature()

BlackboardCLIPSFeature::~BlackboardCLIPSFeature ( )
virtual

Destructor.

Definition at line 61 of file feature_blackboard.cpp.

References fawkes::BlackBoard::close().

Member Function Documentation

◆ clips_context_destroyed()

void BlackboardCLIPSFeature::clips_context_destroyed ( const std::string &  env_name)
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

Implements fawkes::CLIPSFeature.

Definition at line 160 of file feature_blackboard.cpp.

References fawkes::BlackBoard::close(), and fawkes::Logger::log_debug().

◆ clips_context_init()

void BlackboardCLIPSFeature::clips_context_init ( const std::string &  env_name,
fawkes::LockPtr< CLIPS::Environment > &  clips 
)
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

Implements fawkes::CLIPSFeature.

Definition at line 80 of file feature_blackboard.cpp.


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