Fawkes API  Fawkes Development Version
fawkes::TransformAspectIniFin Class Reference

Initializer/finalizer for the TransformAspect. More...

#include <>>

Inheritance diagram for fawkes::TransformAspectIniFin:

Public Member Functions

 TransformAspectIniFin (BlackBoard *blackboard, tf::Transformer *transformer)
 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

Initializer/finalizer for the TransformAspect.

Author
Tim Niemueller

Definition at line 39 of file tf.h.

Constructor & Destructor Documentation

◆ TransformAspectIniFin()

fawkes::TransformAspectIniFin::TransformAspectIniFin ( BlackBoard blackboard,
tf::Transformer transformer 
)

Constructor.

Parameters
blackboardblackboard instance to pass to threads
transformersystem-wide shared transformer to pass to threads

Definition at line 46 of file tf.cpp.

Member Function Documentation

◆ finalize()

void fawkes::TransformAspectIniFin::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 69 of file tf.cpp.

References fawkes::TransformAspect::finalize_TransformAspect(), and fawkes::Thread::name().

◆ init()

void fawkes::TransformAspectIniFin::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 55 of file tf.cpp.

References fawkes::TransformAspect::init_TransformAspect(), and fawkes::Thread::name().


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