Fawkes API  Fawkes Development Version
fawkes::OpenRaveAspectIniFin Class Reference

OpenRaveAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::OpenRaveAspectIniFin:

Public Member Functions

 OpenRaveAspectIniFin (OpenRaveConnector *openrave)
 Constructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. 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

OpenRaveAspect initializer/finalizer.

This initializer/finalizer will provide the OpenRaveConnector to threads with the OpenRaveAspect.

Author
Bahram Maleki-Fard

Definition at line 38 of file openrave_inifin.h.

Constructor & Destructor Documentation

◆ OpenRaveAspectIniFin()

fawkes::OpenRaveAspectIniFin::OpenRaveAspectIniFin ( OpenRaveConnector openrave)

Constructor.

Parameters
openraveOpenRaveConnector to pass on to threads

Definition at line 45 of file openrave_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::OpenRaveAspectIniFin::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 67 of file openrave_inifin.cpp.

◆ init()

void fawkes::OpenRaveAspectIniFin::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 52 of file openrave_inifin.cpp.

References fawkes::Thread::name().


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