Fawkes API  Fawkes Development Version
fawkes::ROSAspectIniFin Class Reference

ROSAspect initializer/finalizer. More...

#include <>>

Inheritance diagram for fawkes::ROSAspectIniFin:

Public Member Functions

 ROSAspectIniFin ()
 Constructor. More...
 
virtual void init (Thread *thread)
 Initialize thread. More...
 
virtual void finalize (Thread *thread)
 Finalize thread. More...
 
void set_rosnode (LockPtr< ros::NodeHandle > rosnode)
 Set the ROS node handle 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

ROSAspect initializer/finalizer.

This initializer/finalizer will provide the ROS node handle to threads with the ROSAspect.

Author
Tim Niemueller

Definition at line 35 of file ros_inifin.h.

Constructor & Destructor Documentation

◆ ROSAspectIniFin()

fawkes::ROSAspectIniFin::ROSAspectIniFin ( )

Constructor.

Definition at line 41 of file ros_inifin.cpp.

Member Function Documentation

◆ finalize()

void fawkes::ROSAspectIniFin::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 64 of file ros_inifin.cpp.

References fawkes::Thread::name().

◆ init()

void fawkes::ROSAspectIniFin::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 47 of file ros_inifin.cpp.

References fawkes::Thread::name().

◆ set_rosnode()

void fawkes::ROSAspectIniFin::set_rosnode ( LockPtr< ros::NodeHandle >  rosnode)

Set the ROS node handle to use for aspect initialization.

Parameters
rosnodeROS node handle to pass to threads with ROSAspect.

Definition at line 81 of file ros_inifin.cpp.

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


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