Fawkes API  Fawkes Development Version
fawkes::NavGraphAspectIniFin Class Reference

NavGraphAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::NavGraphAspectIniFin:

Public Member Functions

 NavGraphAspectIniFin ()
 Constructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
void set_navgraph (LockPtr< NavGraph > &navgraph)
 Set navgraph. 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

NavGraphAspect initializer/finalizer.

Author
Tim Niemueller

Definition at line 37 of file navgraph_inifin.h.

Constructor & Destructor Documentation

◆ NavGraphAspectIniFin()

fawkes::NavGraphAspectIniFin::NavGraphAspectIniFin ( )

Constructor.

Definition at line 41 of file navgraph_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::NavGraphAspectIniFin::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 71 of file navgraph_inifin.cpp.

References fawkes::Thread::name(), and fawkes::NavGraphAspect::navgraph.

◆ init()

void fawkes::NavGraphAspectIniFin::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 57 of file navgraph_inifin.cpp.

References fawkes::Thread::name(), and fawkes::NavGraphAspect::navgraph.

◆ set_navgraph()

void fawkes::NavGraphAspectIniFin::set_navgraph ( LockPtr< NavGraph > &  navgraph)

Set navgraph.

Parameters
navgraphnavgraph to pass to thread with the NavGraphAspect

Definition at line 51 of file navgraph_inifin.cpp.

Referenced by NavGraphThread::init().


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