Fawkes API  Fawkes Development Version
fawkes::BlackBoardAspect Class Reference

Thread aspect to access to BlackBoard. More...

#include <>>

Inherits fawkes::Aspect.

Inherited by AgentControlThread, AmclROSThread, AmclThread, BallPosLogThread, BBLoggerThread, BBLogReplayThread, BlackBoardSynchronizationThread, Bumblebee2Thread, ClipsAgentThread, CLIPSThread, ColliActThread, ColliThread, DepthcamSimThread, DynamixelDriverThread, EclipseAgentThread, ExampleBlackBoardThread, FestivalSynthThread, FliteSynthThread, FvAcquisitionThread, FvSrSavePipelineThread, IMUAcquisitionThread, IMUSensorThread, JacoActThread, JacoBimanualActThread, JacoBimanualGotoThread, JacoGotoThread, JacoInfoThread, JacoOpenraveBaseThread, JoystickActThread, JoystickSensorThread, JoystickTeleOpThread, KatanaActThread, LaserClusterThread, LaserFilterThread, LaserLinesThread, LaserPointCloudThread, LaserSensorThread, LaserSimThread, LocalizationSimThread, LuaAgentContinuousExecutionThread, LuaAgentPeriodicExecutionThread, MapLaserGenThread, MongoLogBlackboardThread, MongoLogTransformsThread, NaoQiButtonThread, NaoQiDCMThread, NaoQiLedThread, NaoQiMotionThread, NaoQiSpeechSynthThread, NavGraphClustersThread, NavGraphGeneratorThread, NavGraphInteractiveThread, NavGraphThread, OpenNiHandTrackerThread, OpenNiUserTrackerThread, OpenPRSThread, OpenRaveMessageHandlerThread, PanTiltActThread, PlayerClientThread, PointCloudDBMergeThread, PointCloudDBRetrieveThread, PointCloudDBROSCommThread, PointCloudDBStoreThread, RefBoxCommThread, RobotinoActThread, RobotinoIrPclThread, RobotinoRosJointsThread, RobotinoSensorThread, RobotinoSimThread, RobotStatePublisherThread, Roomba500Thread, RoombaJoystickThread, RosClockThread, ROSCmdVelThread, RosJointThread, RosLaserScanThread, RosMoveBaseThread, RosNavgraphBreakoutThread, RosNavigatorThread, ROSOdometryThread, RosPosition3DThread, RosSkillerThread, RosTfThread, SkillerExecutionThread, StaticTransformsThread, TabletopObjectsThread, TfExampleThread, VisLocalizationThread, WebcamSimThread, WebviewPtzCamThread, WebviewThread, XabslEngineThread, and XmlRpcThread.

Public Member Functions

 BlackBoardAspect (const char *owner=NULL)
 Constructor. More...
 
virtual ~BlackBoardAspect ()
 Virtual empty destructor. More...
 
void init_BlackBoardAspect (BlackBoard *bb)
 Init BlackBoard aspect. More...
 
- Public Member Functions inherited from fawkes::Aspect
const std::list< const char * > & get_aspects () const
 Get list of aspect names attached to a aspected thread. More...
 

Protected Attributes

BlackBoardblackboard
 This is the BlackBoard instance you can use to interact with the BlackBoard. More...
 

Friends

class BlackBoardAspectIniFin
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Aspect
void add_aspect (const char *name)
 Add an aspect to a thread. More...
 

Detailed Description

Thread aspect to access to BlackBoard.

Give this aspect to your thread to gain access to the BlackBoard. It is guaranteed that if used properly from within plugins that the blackboard member has been initialized properly.

Author
Tim Niemueller

Definition at line 34 of file blackboard.h.

Constructor & Destructor Documentation

◆ BlackBoardAspect()

fawkes::BlackBoardAspect::BlackBoardAspect ( const char *  owner = NULL)

Constructor.

Parameters
ownerowner name to set for opened interfaces. Set this to the plugin name for example. By default, the thread having the BlackBoardAspect will be used.

Definition at line 50 of file blackboard.cpp.

References fawkes::Aspect::add_aspect(), and blackboard.

◆ ~BlackBoardAspect()

fawkes::BlackBoardAspect::~BlackBoardAspect ( )
virtual

Virtual empty destructor.

Definition at line 59 of file blackboard.cpp.

Member Function Documentation

◆ init_BlackBoardAspect()

void fawkes::BlackBoardAspect::init_BlackBoardAspect ( BlackBoard bb)

Init BlackBoard aspect.

This set the BlackBoard interface manager that can be used to access the BB. It is guaranteed that this is called for a BlackBoardThread before start is called (when running regularly inside Fawkes).

Parameters
bbBlackBoard to use

Definition at line 72 of file blackboard.cpp.

References blackboard.

Referenced by fawkes::BlackBoardAspectIniFin::init().

Member Data Documentation

◆ blackboard

BlackBoard * fawkes::BlackBoardAspect::blackboard
protected

This is the BlackBoard instance you can use to interact with the BlackBoard.

It is set when the thread starts.

Definition at line 44 of file blackboard.h.

Referenced by RosJointThread::bb_interface_created(), RosPosition3DThread::bb_interface_created(), MongoLogBlackboardThread::bb_interface_created(), LaserPointCloudThread::bb_interface_created(), RosLaserScanThread::bb_interface_created(), RosTfThread::bb_interface_created(), RobotStatePublisherThread::bb_interface_created(), RosJointThread::bb_interface_reader_removed(), RosPosition3DThread::bb_interface_reader_removed(), LaserPointCloudThread::bb_interface_reader_removed(), RosLaserScanThread::bb_interface_reader_removed(), RosTfThread::bb_interface_reader_removed(), RobotStatePublisherThread::bb_interface_reader_removed(), BlackBoardAspect(), fawkes::BlackBoardAspectIniFin::finalize(), ExampleBlackBoardThread::finalize(), JacoActThread::finalize(), JacoBimanualActThread::finalize(), JoystickSensorThread::finalize(), BallPosLogThread::finalize(), RoombaJoystickThread::finalize(), AgentControlThread::finalize(), ROSOdometryThread::finalize(), OpenRaveMessageHandlerThread::finalize(), RobotinoRosJointsThread::finalize(), ROSCmdVelThread::finalize(), IMUSensorThread::finalize(), FestivalSynthThread::finalize(), JoystickTeleOpThread::finalize(), RosNavgraphBreakoutThread::finalize(), PanTiltDirectedPerceptionThread::finalize(), RosJointThread::finalize(), LaserSensorThread::finalize(), WebviewPtzCamThread::finalize(), FliteSynthThread::finalize(), PanTiltSonyEviD100PThread::finalize(), RobotinoIrPclThread::finalize(), RosNavigatorThread::finalize(), RosPosition3DThread::finalize(), MongoLogBlackboardThread::finalize(), RefBoxCommThread::finalize(), LaserSimThread::finalize(), OpenNiHandTrackerThread::finalize(), IMUAcquisitionThread::finalize(), MapLaserGenThread::finalize(), PointCloudDBStoreThread::finalize(), NaoQiSpeechSynthThread::finalize(), NavGraphGeneratorThread::finalize(), RobotinoSensorThread::finalize(), LocalizationSimThread::finalize(), VisLocalizationThread::finalize(), NaoQiMotionThread::finalize(), LaserPointCloudThread::finalize(), NaoQiLedThread::finalize(), ClipsAgentThread::finalize(), LaserFilterThread::finalize(), RosLaserScanThread::finalize(), RosMoveBaseThread::finalize(), PointCloudDBRetrieveThread::finalize(), ColliActThread::finalize(), RosSkillerThread::finalize(), BBLogReplayThread::finalize(), DynamixelDriverThread::finalize(), AmclROSThread::finalize(), XabslEngineThread::finalize(), NaoQiButtonThread::finalize(), RobotinoActThread::finalize(), OpenNiUserTrackerThread::finalize(), PanTiltRX28Thread::finalize(), PointCloudDBMergeThread::finalize(), BBLoggerThread::finalize(), NavGraphClustersThread::finalize(), PointCloudDBROSCommThread::finalize(), LaserClusterThread::finalize(), NaoQiDCMThread::finalize(), RosTfThread::finalize(), LuaAgentPeriodicExecutionThread::finalize(), RobotinoSimThread::finalize(), LuaAgentContinuousExecutionThread::finalize(), PlayerClientThread::finalize(), NavGraphThread::finalize(), ColliThread::finalize(), FvAcquisitionThread::finalize(), Bumblebee2Thread::finalize(), SkillerExecutionThread::finalize(), KatanaActThread::finalize(), LaserLinesThread::finalize(), NavGraphInteractiveThread::finalize(), RobotStatePublisherThread::finalize(), TabletopObjectsThread::finalize(), OpenNiHandTrackerThread::hand_create(), OpenNiHandTrackerThread::hand_destroy(), ExampleBlackBoardThread::init(), JacoActThread::init(), BallPosLogThread::init(), JacoBimanualActThread::init(), JoystickSensorThread::init(), AgentControlThread::init(), ROSOdometryThread::init(), RoombaJoystickThread::init(), ROSCmdVelThread::init(), OpenRaveMessageHandlerThread::init(), JoystickTeleOpThread::init(), RobotinoRosJointsThread::init(), EclipseAgentThread::init(), FestivalSynthThread::init(), IMUSensorThread::init(), WebviewPtzCamThread::init(), RosNavgraphBreakoutThread::init(), PanTiltDirectedPerceptionThread::init(), RobotinoIrPclThread::init(), RosJointThread::init(), LaserSensorThread::init(), FliteSynthThread::init(), PanTiltSonyEviD100PThread::init(), MongoLogBlackboardThread::init(), IMUAcquisitionThread::init(), RosNavigatorThread::init(), LaserSimThread::init(), MapLaserGenThread::init(), RosPosition3DThread::init(), PointCloudDBStoreThread::init(), Roomba500Thread::init(), NaoQiSpeechSynthThread::init(), NavGraphGeneratorThread::init(), RefBoxCommThread::init(), RobotinoSensorThread::init(), LocalizationSimThread::init(), VisLocalizationThread::init(), CLIPSThread::init(), NaoQiMotionThread::init(), LaserPointCloudThread::init(), NaoQiLedThread::init(), ClipsAgentThread::init(), RosLaserScanThread::init(), PointCloudDBRetrieveThread::init(), RosMoveBaseThread::init(), LaserFilterThread::init(), ColliActThread::init(), RobotinoActThread::init(), NaoQiButtonThread::init(), RosSkillerThread::init(), AmclROSThread::init(), PanTiltRX28Thread::init(), PointCloudDBMergeThread::init(), BBLogReplayThread::init(), XabslEngineThread::init(), DynamixelDriverThread::init(), NavGraphClustersThread::init(), PointCloudDBROSCommThread::init(), BBLoggerThread::init(), LaserClusterThread::init(), NaoQiDCMThread::init(), RosTfThread::init(), LuaAgentPeriodicExecutionThread::init(), RobotinoSimThread::init(), LuaAgentContinuousExecutionThread::init(), NavGraphThread::init(), ColliThread::init(), PlayerClientThread::init(), FvAcquisitionThread::init(), Bumblebee2Thread::init(), SkillerExecutionThread::init(), KatanaActThread::init(), NavGraphInteractiveThread::init(), LaserLinesThread::init(), WebviewThread::init(), RobotStatePublisherThread::init(), TabletopObjectsThread::init(), init_BlackBoardAspect(), BlackBoardSynchronizationThread::loop(), RosLaserScanThread::loop(), NavGraphClustersThread::loop(), ColliThread::loop(), OpenNiUserTrackerThread::new_user(), MongoLogBlackboardThread::run(), LaserFilterThread::wait_done(), LuaAgentContinuousExecutionThread::~LuaAgentContinuousExecutionThread(), and LuaAgentPeriodicExecutionThread::~LuaAgentPeriodicExecutionThread().


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