Fawkes API  Fawkes Development Version
fawkes::VisionAspectIniFin Class Reference

Initializer/finalizer for the VisionAspect. More...

#include <>>

Inheritance diagram for fawkes::VisionAspectIniFin:

Public Member Functions

 VisionAspectIniFin (VisionMasterAspectIniFin *master_inifin)
 Constructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
virtual bool prepare_finalize (Thread *thread)
 Default finalize preparation. More...
 
- Public Member Functions inherited from fawkes::AspectIniFin
 AspectIniFin (const char *aspect_name) __attribute__((nonnull))
 Constructor. More...
 
virtual ~AspectIniFin ()
 Virtual empty destructor. More...
 
const char * get_aspect_name () const
 Get aspect name. More...
 

Detailed Description

Initializer/finalizer for the VisionAspect.

Author
Tim Niemueller

Definition at line 37 of file vision.h.

Constructor & Destructor Documentation

◆ VisionAspectIniFin()

fawkes::VisionAspectIniFin::VisionAspectIniFin ( VisionMasterAspectIniFin master_inifin)

Constructor.

Parameters
master_inifinvision master aspect inifin to get master from

Definition at line 42 of file vision.cpp.

Member Function Documentation

◆ finalize()

void fawkes::VisionAspectIniFin::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 106 of file vision.cpp.

References fawkes::Exception::append(), fawkes::Thread::name(), and fawkes::VisionMasterAspectIniFin::remove_vision_thread().

◆ init()

void fawkes::VisionAspectIniFin::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 50 of file vision.cpp.

References fawkes::VisionMasterAspectIniFin::add_vision_thread(), fawkes::Exception::append(), fawkes::VisionAspect::CONTINUOUS, fawkes::VisionAspect::CYCLIC, fawkes::VisionAspect::init_VisionAspect(), fawkes::Thread::name(), fawkes::Thread::opmode(), fawkes::Thread::OPMODE_CONTINUOUS, fawkes::Thread::OPMODE_WAITFORWAKEUP, fawkes::VisionMasterAspectIniFin::vision_master(), and fawkes::VisionAspect::vision_thread_mode().

◆ prepare_finalize()

bool fawkes::VisionAspectIniFin::prepare_finalize ( Thread thread)
virtual

Default finalize preparation.

This is a default implementation that assumes that finalization is always safe. Override it if you need to make more fine-grained decisions.

Parameters
threadthread to prepare for finalization
Returns
always true

Reimplemented from fawkes::AspectIniFin.

Definition at line 88 of file vision.cpp.

References fawkes::VisionMasterAspectIniFin::can_remove_vision_thread().


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