Fawkes API  Fawkes Development Version
fawkes::CLIPSAspect Class Reference

Thread aspect to get access to a CLIPS environment. More...

#include <>>

Inheritance diagram for fawkes::CLIPSAspect:

Public Member Functions

 CLIPSAspect (const char *env_name, const char *log_component_name=0)
 Constructor. More...
 
virtual ~CLIPSAspect ()
 Virtual empty destructor. More...
 
- Public Member Functions inherited from fawkes::Aspect
const std::list< const char * > & get_aspects () const
 Get list of aspect names attached to a aspected thread. More...
 

Protected Attributes

const std::string clips_env_name
 CLIPS environment name. More...
 
LockPtr< CLIPS::Environment > clips
 CLIPS environment for exclusive usage. More...
 

Friends

class CLIPSAspectIniFin
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Aspect
void add_aspect (const char *name)
 Add an aspect to a thread. More...
 

Detailed Description

Thread aspect to get access to a CLIPS environment.

Give this aspect to your thread to get a CLIPS environment for exclusive usage.

Author
Tim Niemueller

Definition at line 41 of file clips.h.

Constructor & Destructor Documentation

◆ CLIPSAspect()

fawkes::CLIPSAspect::CLIPSAspect ( const char *  env_name,
const char *  log_component_name = 0 
)

Constructor.

Parameters
env_nameCLIPS environment name, the environment name is unique, if you request an environment already occupied by another the exclusive parameter defines whether an error is thrown or if the environment is shared
log_component_namea component name that is shown in log messages. It is strongly recommended to set this to something unique. If left out will be set to "CLIPS[env_name]".

Definition at line 58 of file clips.cpp.

References fawkes::Aspect::add_aspect().

◆ ~CLIPSAspect()

fawkes::CLIPSAspect::~CLIPSAspect ( )
virtual

Virtual empty destructor.

Definition at line 67 of file clips.cpp.

References fawkes::LockPtr< T_CppObject >::clear(), and clips.

Member Data Documentation

◆ clips

fawkes:LockPtr< CLIPS::Environment > fawkes::CLIPSAspect::clips
protected

CLIPS environment for exclusive usage.

Definition at line 51 of file clips.h.

Referenced by ClipsAgentThread::finalize(), fawkes::CLIPSAspectIniFin::init(), ClipsAgentThread::init(), ClipsAgentThread::loop(), and ~CLIPSAspect().

◆ clips_env_name

const std::string fawkes::CLIPSAspect::clips_env_name
protected

CLIPS environment name.

Definition at line 50 of file clips.h.

Referenced by fawkes::CLIPSAspectIniFin::finalize(), and fawkes::CLIPSAspectIniFin::init().


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