Fawkes API  Fawkes Development Version
fawkes::CLIPSFeatureAspectIniFin Class Reference

CLIPSFeatureAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::CLIPSFeatureAspectIniFin:

Public Member Functions

 CLIPSFeatureAspectIniFin ()
 Constructor. More...
 
 ~CLIPSFeatureAspectIniFin ()
 Destructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
virtual bool prepare_finalize (Thread *thread)
 Default finalize preparation. 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...
 
const char * get_aspect_name () const
 Get aspect name. More...
 

Detailed Description

CLIPSFeatureAspect initializer/finalizer.

Author
Tim Niemueller

Definition at line 40 of file clips_feature_inifin.h.

Constructor & Destructor Documentation

◆ CLIPSFeatureAspectIniFin()

fawkes::CLIPSFeatureAspectIniFin::CLIPSFeatureAspectIniFin ( )

Constructor.

Definition at line 41 of file clips_feature_inifin.cpp.

◆ ~CLIPSFeatureAspectIniFin()

fawkes::CLIPSFeatureAspectIniFin::~CLIPSFeatureAspectIniFin ( )

Destructor.

Definition at line 47 of file clips_feature_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::CLIPSFeatureAspectIniFin::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 84 of file clips_feature_inifin.cpp.

References fawkes::Thread::name().

◆ init()

void fawkes::CLIPSFeatureAspectIniFin::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 54 of file clips_feature_inifin.cpp.

References fawkes::Thread::name().

◆ prepare_finalize()

bool fawkes::CLIPSFeatureAspectIniFin::prepare_finalize ( Thread thread)
virtual

Default finalize preparation.

This is a default implementation that assumes that finalization is always safe. Override it if you need to make more fine-grained decisions.

Parameters
threadthread to prepare for finalization
Returns
always true

Reimplemented from fawkes::AspectIniFin.

Definition at line 69 of file clips_feature_inifin.cpp.

◆ set_manager()

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

Set CLIPS environment manger.

Parameters
clips_env_mgrCLIPS environment manager

Definition at line 103 of file clips_feature_inifin.cpp.

Referenced by CLIPSThread::init().


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