Fawkes API  Fawkes Development Version
fawkes::CLIPSAspectIniFin Class Reference

CLIPSAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::CLIPSAspectIniFin:

Public Member Functions

 CLIPSAspectIniFin ()
 Constructor. More...
 
 ~CLIPSAspectIniFin ()
 Destructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
void set_manager (LockPtr< CLIPSEnvManager > &clips_env_mgr)
 Set CLIPS environment manger. More...
 
- Public Member Functions inherited from fawkes::AspectIniFin
 AspectIniFin (const char *aspect_name) __attribute__((nonnull))
 Constructor. More...
 
virtual ~AspectIniFin ()
 Virtual empty destructor. More...
 
virtual bool prepare_finalize (Thread *thread)
 Default finalize preparation. More...
 
const char * get_aspect_name () const
 Get aspect name. More...
 

Detailed Description

CLIPSAspect initializer/finalizer.

This initializer/finalizer will provide the CLIPS node handle to threads with the CLIPSAspect.

Author
Tim Niemueller

Definition at line 41 of file clips_inifin.h.

Constructor & Destructor Documentation

◆ CLIPSAspectIniFin()

fawkes::CLIPSAspectIniFin::CLIPSAspectIniFin ( )

Constructor.

Definition at line 43 of file clips_inifin.cpp.

◆ ~CLIPSAspectIniFin()

fawkes::CLIPSAspectIniFin::~CLIPSAspectIniFin ( )

Destructor.

Definition at line 49 of file clips_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::CLIPSAspectIniFin::finalize ( Thread thread)
virtual

Finalize thread.

The aspect for the given thread must be initialized. Use dynamic_cast to cast the thread into the expected aspect class. An exception must be thrown if this fails. If anything fails during initialization of the aspect an Exception must be thrown. This will not prevent the thread from being removed. Use prepare_finalize() to report problems that should prevent the thread from being unloaded.

Parameters
threadthread to finalize

Implements fawkes::AspectIniFin.

Definition at line 74 of file clips_inifin.cpp.

References fawkes::CLIPSAspect::clips_env_name, and fawkes::Thread::name().

◆ init()

void fawkes::CLIPSAspectIniFin::init ( Thread thread)
virtual

Initialize thread.

The aspect for the given thread must be initialized. Use dynamic_cast to cast the thread into the expected aspect class. An exception must be thrown if this fails. If anything fails during initialization of the aspect an Exception must be thrown.

Parameters
threadthread to initialize

Implements fawkes::AspectIniFin.

Definition at line 56 of file clips_inifin.cpp.

References fawkes::CLIPSAspect::clips, fawkes::CLIPSAspect::clips_env_name, and fawkes::Thread::name().

◆ set_manager()

void fawkes::CLIPSAspectIniFin::set_manager ( LockPtr< CLIPSEnvManager > &  clips_env_mgr)

Set CLIPS environment manger.

Parameters
clips_env_mgrCLIPS environment manager

Definition at line 94 of file clips_inifin.cpp.

Referenced by CLIPSThread::init().


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