Fawkes API  Fawkes Development Version
fawkes::NaoQiAspectIniFin Class Reference

NaoQiAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::NaoQiAspectIniFin:

Public Member Functions

 NaoQiAspectIniFin ()
 Constructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
void set_naoqi_broker (AL::ALPtr< AL::ALBroker > naoqi_broker)
 Set the NaoQi broker to use for aspect initialization. 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

NaoQiAspect initializer/finalizer.

This initializer/finalizer will provide the NaoQi broker to threads with the NaoQiAspect.

Author
Tim Niemueller

Definition at line 35 of file naoqi_inifin.h.

Constructor & Destructor Documentation

◆ NaoQiAspectIniFin()

fawkes::NaoQiAspectIniFin::NaoQiAspectIniFin ( )

Constructor.

Definition at line 40 of file naoqi_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::NaoQiAspectIniFin::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 63 of file naoqi_inifin.cpp.

◆ init()

void fawkes::NaoQiAspectIniFin::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 46 of file naoqi_inifin.cpp.

References fawkes::Thread::name().

◆ set_naoqi_broker()

void fawkes::NaoQiAspectIniFin::set_naoqi_broker ( AL::ALPtr< AL::ALBroker >  naoqi_broker)

Set the NaoQi broker to use for aspect initialization.

Parameters
naoqi_brokerNaoQi broker to pass to threads with NaoQiAspect.

Definition at line 72 of file naoqi_inifin.cpp.

Referenced by NaoQiBrokerThread::finalize(), and NaoQiBrokerThread::init().


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