Logging Class Reference

Base Class for all Logging classes. More...

#include <ArmarXCore/core/logging/Logging.h>

Inherited by MultiDimPIDControllerTemplate< 3 >, PeriodicTask< SharedRemoteHandleState > [virtual], PeriodicTask< SimplePeriodicTask< std::function< void(void)> > > [virtual], PeriodicTask< armarx::Observer > [virtual], PeriodicTask< Stream::StreamProviderI > [virtual], PeriodicTask< armarx::AffordanceExtraction > [virtual], PeriodicTask< armarx::ArmarXTimeserver > [virtual], PeriodicTask< armarx::ArticulatedObjectLocalizerDynamicSimulation > [virtual], PeriodicTask< armarx::CoFusionProcessor > [virtual], PeriodicTask< armarx::CollisionCheckerComponent > [virtual], PeriodicTask< armarx::ConditionViewerWidget > [virtual], PeriodicTask< armarx::ConditionViewerWidgetController > [virtual], PeriodicTask< armarx::DSObstacleAvoidance > [virtual], PeriodicTask< armarx::DataFieldPropertiesWidget > [virtual], PeriodicTask< armarx::DynamicObstacleManager > [virtual], PeriodicTask< armarx::ForceTorqueObserver > [virtual], PeriodicTask< armarx::ForceTorqueUnitSimulation > [virtual], PeriodicTask< armarx::FrameTracking > [virtual], PeriodicTask< armarx::HandEyeCalibrationWidgetController > [virtual], PeriodicTask< armarx::HandUnitWidget > [virtual], PeriodicTask< armarx::HapticObserver > [virtual], PeriodicTask< armarx::HeadIKUnit > [virtual], PeriodicTask< armarx::HumanObstacleDetection > [virtual], PeriodicTask< armarx::IMUSimulation > [virtual], PeriodicTask< armarx::KinematicSelfLocalization > [virtual], PeriodicTask< armarx::KinematicUnitDynamicSimulation > [virtual], PeriodicTask< armarx::KinematicUnitSimulation > [virtual], PeriodicTask< armarx::LaserScannerObstacleDetection > [virtual], PeriodicTask< armarx::LaserScannerSelfLocalisation > [virtual], PeriodicTask< armarx::NJointBimanualCCDMPController > [virtual], PeriodicTask< armarx::ObjectLocalizationSaliency > [virtual], PeriodicTask< armarx::PlatformUnitDynamicSimulation > [virtual], PeriodicTask< armarx::PlatformUnitSimulation > [virtual], PeriodicTask< armarx::PlotterController > [virtual], PeriodicTask< armarx::ProcessWatcher > [virtual], PeriodicTask< armarx::Profiler::IceBufferedLoggingStrategy > [virtual], PeriodicTask< armarx::RTABMapRegistration > [virtual], PeriodicTask< armarx::Reflex > [virtual], PeriodicTask< armarx::ReflexCombination > [virtual], PeriodicTask< armarx::ResultImageFuser > [virtual], PeriodicTask< armarx::RobotHealth > [virtual], PeriodicTask< armarx::RobotPoseUnitDynamicSimulation > [virtual], PeriodicTask< armarx::SelfLocalizationDynamicSimulation > [virtual], PeriodicTask< armarx::SemanticRelationAnalyzer > [virtual], PeriodicTask< armarx::SimpleEpisodicMemoryKinematicUnitConnector > [virtual], PeriodicTask< armarx::SimpleEpisodicMemoryPlatformUnitConnector > [virtual], PeriodicTask< armarx::Simulator > [virtual], PeriodicTask< armarx::StateWatcher > [virtual], PeriodicTask< armarx::StatechartEditorController > [virtual], PeriodicTask< armarx::StatechartViewerController > [virtual], PeriodicTask< armarx::StreamImageProvider > [virtual], PeriodicTask< armarx::StreamReceiver > [virtual], PeriodicTask< StreamElements > [virtual], PeriodicTask< armarx::SystemStateMonitorWidget > [virtual], PeriodicTask< armarx::TCPControlUnit > [virtual], PeriodicTask< armarx::ThreadViewer > [virtual], PeriodicTask< armarx::TrajectoryControllerSubUnit > [virtual], PeriodicTask< armarx::TrajectoryPlayer > [virtual], PeriodicTask< armarx::ViewSelection > [virtual], PeriodicTask< armarx::armem::LegacyRobotStateMemoryAdapter > [virtual], PeriodicTask< armarx::armem::server::ltm::detail::mixin::BufferedMemoryMixin > [virtual], PeriodicTask< armarx::armem::server::obj::instance::ArticulatedObjectVisu > [virtual], PeriodicTask< armarx::armem::server::systemstate::segment::LightweightCpuMonitorProviderSegment > [virtual], PeriodicTask< armarx::armem::server::systemstate::segment::LightweightRamMonitorProviderSegment > [virtual], PeriodicTask< armarx::articulated_object::ArticulatedObjectLocalizerExample > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::adaptive::NJointAdaptiveWipingController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::adaptive::NJointAnomalyDetectionAdaptiveWipingController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::adaptive::NJointTaskSpaceAdaptiveDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::bimanual::NJointBimanualCCDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::bimanual::NJointBimanualForceMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::DeprecatedNJointPeriodicTSDMPCompliantController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::DeprecatedNJointTSDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::DeprecatedNJointTaskSpaceAdmittanceDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::DeprecatedNJointTaskSpaceImpedanceDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::NJointCCDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::NJointPeriodicTSDMPCompliantController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::NJointPeriodicTSDMPForwardVelController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::NJointTSDMPController > [virtual], PeriodicTask< armarx::control::deprecated_njoint_mp_controller::task_space::NJointTaskSpaceImpedanceDMPController > [virtual], PeriodicTask< armarx::familiar_objects::FamiliarObjectDetectionExample > [virtual], PeriodicTask< armarx::laser_scanner_simulation::LaserScannerSimulation > [virtual], PeriodicTask< armarx::navigation::client::MemoryPolling > [virtual], PeriodicTask< armarx::navigation::components::dynamic_scene_provider::Component > [virtual], PeriodicTask< armarx::navigation::components::human_simulator::Component > [virtual], PeriodicTask< armarx::navigation::components::laser_scanner_feature_extraction::LaserScannerFeatureExtraction > [virtual], PeriodicTask< armarx::navigation::components::social_cost_map::Component > [virtual], PeriodicTask< armarx::navigation::server::Navigator > [virtual], PeriodicTask< armarx::view_selection::client::MemoryPolling > [virtual], PeriodicTask< armarx::virtual_robot_writer_example::VirtualRobotWriterExample > [virtual], PeriodicTask< memoryx::CommonStorage > [virtual], PeriodicTask< memoryx::MotionModelKBM > [virtual], PeriodicTask< memoryx::ObjectLocalizationMemoryUpdater > [virtual], PeriodicTask< memoryx::SegmentLock > [virtual], PeriodicTask< memoryx::SegmentUtilImplementations > [virtual], PeriodicTask< visionx::ImageMonitorWidgetController > [virtual], PeriodicTask< visionx::ImageProcessor > [virtual], PeriodicTask< visionx::SimpleEpisodicMemoryImageConnector > [virtual], PeriodicTask< visionx::UserAssistedSegmenter > [virtual], SegmentBase< server::wm::CoreSegment >, SegmentBase< server::wm::ProviderSegment >, FinderBase< std::string, PKFinderInfo >, RoundRectItem, ScenarioListController, ArmarXGuiApp [virtual], ArmarXMainWindow [virtual], ArmarXManager [virtual], ArmarXMultipleObjectsScheduler [virtual], ArmarXObjectScheduler [virtual], ArmarXWidgetController [virtual], ConditionCheckMagnitudeInRange [private], ConditionCheckMagnitudeLarger [private], ConditionCheckMagnitudeSmaller [private], DMPInstance [virtual], DynamicLibrary, EDifferentialIK [virtual], EditorFileOpener, EventSenderComponent [virtual], EventSenderConfigDialog [virtual], IceManager [virtual], LogTable, ManagedIceObject [virtual], MultiDimPIDControllerTemplate< dimensions >, ObjectFinder [private], PIDController, ParameterMapping [virtual], PeriodicTask< T > [virtual], SimMJCF [private], SimulatedWorld, StateBase [virtual], StateScene, StatechartManager [virtual], TermNode, TransitionItem, WeissHapticSensor, MemoryViewer, LivePlotController, LivePlotWorker, MemoryGroupBoxController, PeriodicUpdateController, PeriodicUpdateWorker, DataView, Registry, Visu, Finder [private], Visu, Segment, Decay, Segment::RobotsCache, SegmentAdapter [virtual], Visu, ArticulatedObjectVisu, Decay, RobotHeadMovement, Segment::RobotsCache, SegmentAdapter [virtual], Visu, LinearPredictions, Visu, RobotStateWriter, RobotUnitReader, SegmentBase< SegmentType >, Bus [virtual], BusErrorHandler, RTUnit [virtual], SlaveInterface, Reporting [virtual], Pointing [virtual], FinderBase< IDType, FinderInfoType >, ArmarXLog, Skill, SkillProxy, SkillRuntime, SkillMemoryGUI, State, StateInstance, GridFileManager, ImageViewerArea, and Component [virtual].

Public Member Functions
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds.
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
void	setTag (const LogTag &tag)
void	setTag (const std::string &tagName)
virtual	~Logging ()

Protected Member Functions
bool	checkLogLevel (MessageTypeT level) const
const LogSenderPtr &	getLogSender () const
	Retrieve log sender.
LogSenderPtr	loghelper (const char *file, int line, const char *function) const

Protected Attributes
MessageTypeT	minimumLoggingLevel
SpamFilterDataPtr	spamFilter
LogTag	tag

Detailed Description

Base Class for all Logging classes.

Inherit from this class in order to use ArmarX Logging facitities.

You should call setTag() in the derived class's constructor, otherwise the category string will be empty.

Constructor & Destructor Documentation

Logging()

Logging

(

)

~Logging()

~Logging ( )

virtual

Member Function Documentation

checkLogLevel()

bool checkLogLevel ( MessageTypeT level ) const

protected

deactivateSpam()

SpamFilterDataPtr deactivateSpam	(	float	deactivationDurationSec = 10.0f,
		const std::string &	identifier = "",
		bool	deactivate = true ) const

disables the logging for the current line for the given amount of seconds.

Usage:

ARMARX_INFO << deactivateSpam(1) << "My Controller value" << x;

Note

Needs to be called like above. Just calling it has no effect.

Parameters

deactivationDurationSec	Duration for which the logging is deactivated.
identifier	Additional log entry identifier. Useful, when having a loop and each iteration should be printed.
deactivate	If true the logging is disabled. If false the logging is immediately enabled.

Returns

Internal datastruct for the logging framework.

getEffectiveLoggingLevel()

MessageTypeT getEffectiveLoggingLevel

(

)

const

getLogSender()

const LogSenderPtr & getLogSender ( ) const

protected

Retrieve log sender.

This method is usually called by using one of the loggin macro ARMARX_LOG.

Returns

pointer to the logSender

loghelper()

LogSenderPtr loghelper ( const char * file, int line, const char * function ) const

protected

setLocalMinimumLoggingLevel()

void setLocalMinimumLoggingLevel

(

MessageTypeT

level

)

With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.

Parameters

level

The minimum logging level

setTag() [1/2]

void setTag

(

const LogTag &

tag

)

setTag() [2/2]

void setTag

(

const std::string &

tagName

)

Member Data Documentation

minimumLoggingLevel

MessageTypeT minimumLoggingLevel

protected

spamFilter

SpamFilterDataPtr spamFilter

mutableprotected

tag

LogTag tag

protected

---

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

• ArmarXCore/core/logging/Logging.h
• ArmarXCore/core/logging/Logging.cpp