Fawkes API Fawkes Development Version
fawkes::ASPAspectIniFin Class Reference

ASPAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::ASPAspectIniFin:

Public Member Functions

 ASPAspectIniFin (void)
 Constructor. More...
 
 ~ASPAspectIniFin (void)
 Destructor. More...
 
void init (Thread *thread) override
 Initialize thread. More...
 
void finalize (Thread *thread) override
 Finalize thread. More...
 
void set_control_manager (const LockPtr< ClingoControlManager > &ctrl_mgr)
 Sets the control manager. More...
 
- Public Member Functions inherited from fawkes::AspectIniFin
 AspectIniFin (const char *aspect_name) __attribute__((nonnull))
 Constructor. More...
 
virtual ~AspectIniFin ()
 Virtual empty destructor. More...
 
virtual void init (Thread *thread)=0
 Initialize thread. More...
 
virtual void finalize (Thread *thread)=0
 Finalize thread. More...
 
virtual bool prepare_finalize (Thread *thread)
 Default finalize preparation. More...
 
const char * get_aspect_name () const
 Get aspect name. More...
 

Detailed Description

ASPAspect initializer/finalizer.

This initializer/finalizer will provide the ASP node handle to threads with the ASPAspect.

Author
Björn Schäpers

Definition at line 36 of file asp_inifin.h.

Constructor & Destructor Documentation

◆ ASPAspectIniFin()

fawkes::ASPAspectIniFin::ASPAspectIniFin ( void  )

Constructor.

Definition at line 44 of file asp_inifin.cpp.

◆ ~ASPAspectIniFin()

fawkes::ASPAspectIniFin::~ASPAspectIniFin ( void  )

Destructor.

Definition at line 49 of file asp_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::ASPAspectIniFin::finalize ( Thread thread)
overridevirtual

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 68 of file asp_inifin.cpp.

References fawkes::Thread::name().

◆ init()

void fawkes::ASPAspectIniFin::init ( Thread thread)
overridevirtual

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 asp_inifin.cpp.

References fawkes::Thread::name().

◆ set_control_manager()

void fawkes::ASPAspectIniFin::set_control_manager ( const LockPtr< ClingoControlManager > &  ctrl_mgr)

Sets the control manager.

Parameters
[in]ctrl_mgrThe new control manager

Definition at line 84 of file asp_inifin.cpp.

Referenced by ASPThread::init().


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