Fawkes API  Fawkes Development Version
fawkes::LoggingAspect Class Reference

Thread aspect to log output. More...

#include <>>

Inherits fawkes::Aspect.

Inherited by AgentControlThread, AmclROSThread, AmclThread, BallPosLogThread, BBLoggerThread, BBLogReplayThread, BlackBoardSynchronizationThread, Bumblebee2Thread, ClipsAgentThread, ClipsNavGraphThread, ClipsProtobufThread, ClipsROSThread, ClipsTFThread, CLIPSThread, ClipsWebviewThread, ColliActThread, ColliThread, DepthcamSimThread, DynamixelActThread, DynamixelDriverThread, DynamixelSensorThread, EclipseAgentThread, ExampleBlackBoardThread, ExampleFinalizeNettlerThread, ExampleNetworkThread, ExampleThread, FestivalSynthThread, FliteSynthThread, FountainThread, FvAcquisitionThread, FvBaseThread, FvRetrieverThread, FvSrSavePipelineThread, GazeboNodeThread, GazsimCommThread, GazsimTimesourceThread, GossipExampleReceiverThread, GossipExampleSenderThread, GossipThread, IMUAcquisitionThread, IMUSensorThread, JacoActThread, JacoBimanualActThread, JacoBimanualGotoThread, JacoGotoThread, JacoInfoThread, JacoOpenraveBaseThread, JoystickAcquisitionThread, JoystickActThread, JoystickSensorThread, JoystickTeleOpThread, KatanaActThread, KatanaSensorThread, LaserAcquisitionThread, LaserClusterThread, LaserFilterThread, LaserLinesThread, LaserPointCloudThread, LaserSensorThread, LaserSimThread, LocalizationSimThread, LuaAgentContinuousExecutionThread, LuaAgentPeriodicExecutionThread, MapLaserGenThread, MongoDBThread, MongoLogBlackboardThread, MongoLogImagesThread, MongoLogLoggerThread, MongoLogPointCloudThread, MongoLogTransformsThread, MongoRRDThread, NaoQiBrokerThread, NaoQiButtonThread, NaoQiDCMThread, NaoQiLedThread, NaoQiMotionThread, NaoQiSpeechSynthThread, NavGraphClustersThread, NavGraphGeneratorThread, NavGraphGeneratorVisualizationThread, NavGraphInteractiveThread, NavGraphROSPubThread, NavGraphStaticConstraintsThread, NavGraphThread, NavGraphVisualizationThread, OpenNiContextThread, OpenNiDepthThread, OpenNiHandTrackerThread, OpenNiImageThread, OpenNiPclOnlyThread, OpenNiPointCloudThread, OpenNiUserTrackerThread, OpenPRSAgentThread, OpenPRSExampleThread, OpenPRSThread, OpenRaveMessageHandlerThread, OpenRaveThread, PanTiltActThread, PanTiltSensorThread, PlayerClientThread, PointCloudDBMergeThread, PointCloudDBRetrieveThread, PointCloudDBROSCommThread, PointCloudDBStoreThread, ProcRRDThread, RefBoxCommThread, RobotinoActThread, RobotinoComThread, RobotinoIrPclThread, RobotinoRosJointsThread, RobotinoSensorThread, RobotinoSimThread, RobotStatePublisherThread, Roomba500Thread, RoombaJoystickThread, RoombaSensorThread, RosClockThread, ROSCmdVelThread, RosImagesThread, RosJointThread, RosLaserScanThread, RosMoveBaseThread, RosNavgraphBreakoutThread, RosNavigatorThread, ROSNodeThread, ROSOdometryThread, RosPointCloudThread, RosPosition3DThread, ROSRobotDescriptionThread, RosSkillerThread, ROSTalkerPubThread, RosTfThread, ROSWebviewThread, RRDExampleThread, RRDThread, RRDWebThread, SkillerExecutionThread, SkillerNavGraphFeature, StaticTransformsThread, TabletopObjectsThread, TfExampleThread, TimeTrackerMainLoopThread, VisLocalizationThread, WebcamSimThread, WebviewPtzCamThread, WebviewThread, XabslEngineThread, and XmlRpcThread.

Public Member Functions

 LoggingAspect ()
 Constructor. More...
 
virtual ~LoggingAspect ()
 Virtual empty Destructor. More...
 
void init_LoggingAspect (Logger *logger)
 Set the logger. 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

Loggerlogger
 This is the Logger member used to access the logger. More...
 

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 log output.

Give this aspect to your thread to gain access to the central log. When using this thread all output should be done with the logger set for this aspect. Use it to log debug, informational, warning and error messages. The logger allows for some control over what is being displayed and where. It may be simple console logout or a network logger.

It is guaranteed that if used properly from within plugins that initLoggingAspect() is called before the thread is started and that you can access the logger via the logger member.

Author
Tim Niemueller

Definition at line 35 of file logging.h.

Constructor & Destructor Documentation

◆ LoggingAspect()

fawkes::LoggingAspect::LoggingAspect ( )

Constructor.

Definition at line 55 of file logging.cpp.

References fawkes::Aspect::add_aspect().

◆ ~LoggingAspect()

fawkes::LoggingAspect::~LoggingAspect ( )
virtual

Virtual empty Destructor.

Definition at line 62 of file logging.cpp.

Member Function Documentation

◆ init_LoggingAspect()

void fawkes::LoggingAspect::init_LoggingAspect ( Logger logger)

Set the logger.

It is guaranteed that this is called for a logging thread before Thread::start() is called (when running regularly inside Fawkes).

Parameters
loggerLogger instance to use.

Definition at line 73 of file logging.cpp.

References logger.

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

Member Data Documentation

◆ logger

Logger fawkes::LoggingAspect::logger
protected

This is the Logger member used to access the logger.

The logger will remain valid for the whole lifetime of the thread.

Definition at line 44 of file logging.h.

Referenced by RefBoxCommThread::add_penalty(), OpenRaveThread::add_robot(), JacoOpenraveThread::add_target(), 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(), BBLoggerThread::bb_interface_data_changed(), PanTiltDirectedPerceptionThread::bb_interface_message_received(), PanTiltSonyEviD100PThread::bb_interface_message_received(), BBLoggerThread::bb_interface_message_received(), PanTiltRX28Thread::bb_interface_message_received(), DynamixelDriverThread::bb_interface_message_received(), KatanaActThread::bb_interface_message_received(), LaserPointCloudThread::bb_interface_reader_removed(), RosLaserScanThread::bb_interface_reader_removed(), RosTfThread::bb_interface_reader_removed(), BBLoggerThread::bb_interface_writer_removed(), OpenNiUserTrackerThread::calibration_end(), OpenNiUserTrackerThread::calibration_start(), ExampleNetworkThread::client_connected(), ExampleNetworkThread::client_disconnected(), ClipsTFThread::clips_context_destroyed(), ClipsProtobufThread::clips_context_destroyed(), ClipsNavGraphThread::clips_context_destroyed(), ClipsTFThread::clips_context_init(), ClipsProtobufThread::clips_context_init(), ClipsNavGraphThread::clips_context_init(), MongoDBThread::delete_client(), DynamixelDriverThread::exec_act(), DynamixelDriverThread::exec_sensor(), LuaAgentContinuousExecutionThread::fam_event(), NavGraphThread::fam_event(), SickTiM55xUSBAcquisitionThread::finalize(), ExampleFinalizeNettlerThread::finalize(), ExampleNetworkThread::finalize(), ExampleThread::finalize(), ExampleBlackBoardThread::finalize(), LaseEdlAcquisitionThread::finalize(), HokuyoUrgAcquisitionThread::finalize(), JacoActThread::finalize(), JacoBimanualActThread::finalize(), OpenRaveMessageHandlerThread::finalize(), ProcRRDThread::finalize(), ROSCmdVelThread::finalize(), HokuyoUrgGbxAcquisitionThread::finalize(), RosNavgraphBreakoutThread::finalize(), MongoRRDThread::finalize(), JoystickTeleOpThread::finalize(), StaticTransformsThread::finalize(), RosNavigatorThread::finalize(), MapLaserGenThread::finalize(), FvRetrieverThread::finalize(), RosImagesThread::finalize(), RosMoveBaseThread::finalize(), OpenPRSThread::finalize(), RosSkillerThread::finalize(), PanTiltRX28Thread::finalize(), DynamixelDriverThread::finalize(), MongoLogImagesThread::finalize(), LuaAgentPeriodicExecutionThread::finalize(), ColliThread::finalize(), Bumblebee2Thread::finalize(), OpenNiPointCloudThread::finalize(), KatanaActThread::finalize(), SkillerNavGraphFeature::finalize_lua_context(), OpenNiHandTrackerThread::gesture_progress(), OpenNiHandTrackerThread::gesture_recognized(), EclipseAgentThread::get_logger(), NavGraphROSPubThread::graph_changed(), ClipsNavGraphThread::graph_changed(), OpenNiHandTrackerThread::hand_create(), OpenNiHandTrackerThread::hand_destroy(), OpenNiHandTrackerThread::hand_update(), ExampleNetworkThread::handle_network_message(), ExampleFinalizeNettlerThread::init(), SickTiM55xEthernetAcquisitionThread::init(), SickTiM55xUSBAcquisitionThread::init(), ExampleThread::init(), LaseEdlAcquisitionThread::init(), ExampleBlackBoardThread::init(), HokuyoUrgAcquisitionThread::init(), RRDWebThread::init(), NaoQiBrokerThread::init(), JacoActThread::init(), GossipThread::init(), ClipsWebviewThread::init(), OpenRaveMessageHandlerThread::init(), OpenRaveThread::init(), ProcRRDThread::init(), TimeTrackerMainLoopThread::init(), RoombaJoystickThread::init(), NavGraphStaticConstraintsThread::init(), JoystickTeleOpThread::init(), ClipsProtobufThread::init(), EclipseAgentThread::init(), HokuyoUrgGbxAcquisitionThread::init(), MongoRRDThread::init(), RosNavgraphBreakoutThread::init(), PanTiltDirectedPerceptionThread::init(), WebviewPtzCamThread::init(), MongoDBThread::init(), PanTiltSonyEviD100PThread::init(), LaserSensorThread::init(), MongoLogBlackboardThread::init(), MongoLogTransformsThread::init(), JoystickAcquisitionThread::init(), RosNavigatorThread::init(), LaserSimThread::init(), ROSNodeThread::init(), OpenNiHandTrackerThread::init(), PointCloudDBStoreThread::init(), MapLaserGenThread::init(), BlackBoardSynchronizationThread::init(), NavGraphGeneratorThread::init(), GazeboNodeThread::init(), WebcamSimThread::init(), FvRetrieverThread::init(), RefBoxCommThread::init(), Roomba500Thread::init(), DepthcamSimThread::init(), LocalizationSimThread::init(), VisLocalizationThread::init(), CLIPSThread::init(), RosLaserScanThread::init(), OpenNiImageThread::init(), OpenPRSThread::init(), ClipsAgentThread::init(), PointCloudDBRetrieveThread::init(), ColliActThread::init(), RosMoveBaseThread::init(), LaserFilterThread::init(), RosPointCloudThread::init(), BBLogReplayThread::init(), XmlRpcThread::init(), RosSkillerThread::init(), NaoQiButtonThread::init(), PanTiltRX28Thread::init(), PointCloudDBMergeThread::init(), XabslEngineThread::init(), DynamixelDriverThread::init(), MongoLogImagesThread::init(), BBLoggerThread::init(), LaserClusterThread::init(), LuaAgentPeriodicExecutionThread::init(), RobotinoSimThread::init(), LuaAgentContinuousExecutionThread::init(), NavGraphThread::init(), MongoLogPointCloudThread::init(), ColliThread::init(), PlayerClientThread::init(), FvAcquisitionThread::init(), Bumblebee2Thread::init(), SkillerExecutionThread::init(), OpenNiPointCloudThread::init(), KatanaActThread::init(), WebviewThread::init(), RobotStatePublisherThread::init(), TabletopObjectsThread::init(), SickTiM55xCommonAcquisitionThread::init_device(), init_LoggingAspect(), SkillerNavGraphFeature::init_lua_context(), JacoBimanualOpenraveThread::JacoBimanualOpenraveThread(), JacoOpenraveThread::JacoOpenraveThread(), JoystickAcquisitionThread::JoystickAcquisitionThread(), RoombaSensorThread::loop(), SickTiM55xEthernetAcquisitionThread::loop(), ExampleThread::loop(), SickTiM55xUSBAcquisitionThread::loop(), RRDExampleThread::loop(), GossipExampleReceiverThread::loop(), ClipsTFThread::loop(), LaseEdlAcquisitionThread::loop(), OpenPRSAgentThread::loop(), PanTiltSensorThread::loop(), BallPosLogThread::loop(), GossipExampleSenderThread::loop(), JacoBimanualGotoThread::loop(), JacoActThread::loop(), JacoBimanualActThread::loop(), HokuyoUrgAcquisitionThread::loop(), FvSrSavePipelineThread::loop(), ProcRRDThread::loop(), OpenRaveMessageHandlerThread::loop(), RoombaJoystickThread::loop(), ClipsROSThread::loop(), TfExampleThread::loop(), JacoInfoThread::loop(), JoystickTeleOpThread::loop(), MongoRRDThread::loop(), JacoGotoThread::loop(), WebviewPtzCamThread::loop(), CruizCoreXG1010AcquisitionThread::loop(), HokuyoUrgGbxAcquisitionThread::loop(), RosNavgraphBreakoutThread::loop(), PanTiltDirectedPerceptionThread::loop(), PanTiltSonyEviD100PThread::loop(), MapLaserGenThread::loop(), JoystickAcquisitionThread::loop(), MongoLogTransformsThread::loop(), PointCloudDBStoreThread::loop(), ROSWebviewThread::loop(), RosNavigatorThread::loop(), BlackBoardSynchronizationThread::loop(), NavGraphGeneratorThread::loop(), RosImagesThread::loop(), DirectRobotinoComThread::loop(), OpenNiContextThread::loop(), Roomba500Thread::loop(), RobotinoSensorThread::loop(), NaoQiMotionThread::loop(), ClipsAgentThread::loop(), RosLaserScanThread::loop(), PointCloudDBRetrieveThread::loop(), ColliActThread::loop(), FvBaseThread::loop(), LaserFilterThread::loop(), PointCloudDBMergeThread::loop(), RosMoveBaseThread::loop(), RosPointCloudThread::loop(), OpenNiUserTrackerThread::loop(), NaoQiButtonThread::loop(), RobotinoActThread::loop(), BBLogReplayThread::loop(), NavGraphClustersThread::loop(), PointCloudDBROSCommThread::loop(), RosSkillerThread::loop(), MongoLogImagesThread::loop(), LaserClusterThread::loop(), NaoQiDCMThread::loop(), PanTiltRX28Thread::loop(), DynamixelDriverThread::loop(), XabslEngineThread::loop(), LuaAgentPeriodicExecutionThread::loop(), LuaAgentContinuousExecutionThread::loop(), MongoLogPointCloudThread::loop(), NavGraphThread::loop(), ColliThread::loop(), PlayerClientThread::loop(), FvAcquisitionThread::loop(), Bumblebee2Thread::loop(), LaserLinesThread::loop(), KatanaActThread::loop(), OpenRobotinoComThread::loop(), WebviewThread::loop(), RobotStatePublisherThread::loop(), TabletopObjectsThread::loop(), OpenNiUserTrackerThread::lost_user(), JacoBimanualGotoThread::move_gripper(), OpenNiUserTrackerThread::new_user(), EclipseAgentThread::once(), FestivalSynthThread::once(), RosMoveBaseThread::once(), RosSkillerThread::once(), XabslEngineThread::once(), KatanaActThread::once(), JacoBimanualOpenraveThread::plot_first(), OpenNiUserTrackerThread::pose_end(), OpenNiUserTrackerThread::pose_start(), ExampleFinalizeNettlerThread::prepare_finalize_user(), PanTiltRX28Thread::prepare_finalize_user(), AmclROSThread::publish_map(), LuaAgentContinuousExecutionThread::read_interfaces(), FvBaseThread::register_for_camera(), DirectRobotinoComThread::reset_odometry(), MongoLogBlackboardThread::run(), FliteSynthThread::say(), DirectRobotinoComThread::set_bumper_estop_enabled(), OpenRobotinoComThread::set_bumper_estop_enabled(), DirectRobotinoComThread::set_desired_vel(), DirectRobotinoComThread::set_digital_output(), OpenRobotinoComThread::set_digital_output(), BBLoggerThread::set_enabled(), RefBoxCommThread::set_gamestate(), RefBoxCommThread::set_half(), DirectRobotinoComThread::set_motor_accel_limits(), RefBoxCommThread::set_score(), DirectRobotinoComThread::set_speed_points(), JacoOpenraveThread::set_target_ang(), RefBoxCommThread::set_team_goal(), BBLoggerThread::set_threadlist(), FvAcquisitionThread::set_vt_prepfin_hold(), JacoGotoThread::stop(), PlayerClientThread::sync_fawkes_to_player(), FvBaseThread::unregister_thread(), KatanaActThread::update_sensor_values(), LaserFilterThread::wait_done(), LuaAgentContinuousExecutionThread::write_interfaces(), BlackBoardSynchronizationThread::writer_added(), BlackBoardSynchronizationThread::writer_removed(), LuaAgentContinuousExecutionThread::~LuaAgentContinuousExecutionThread(), LuaAgentPeriodicExecutionThread::~LuaAgentPeriodicExecutionThread(), and NavGraphInteractiveThread::~NavGraphInteractiveThread().


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