PlogArmarXAppender.h

Go to the documentation of this file.

/*
* This file is part of ArmarX.
*
* Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
*
* ArmarX is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* ArmarX is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package    ArmarXCore::core
* @date       2026
* @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
*             GNU General Public License
*/
#pragma once
 
#if ARMARX_PLOG_SUPPORT
 
#include <string>
 
#include <plog/Appenders/IAppender.h>
 
namespace armarx
{
    /**
      \class PlogArmarXAppender
      \brief Bridges plog log records (e.g. from Simox) into the ArmarX logging framework.
      \ingroup Logging
 
      Implements plog's IAppender interface. Each record is forwarded into
      armarx::LogSender, so it appears in the ArmarX console output and LogViewer
      exactly like a message logged via ARMARX_INFO and friends, respecting the
      same activation/verbosity settings.
    */
    class PlogArmarXAppender : public plog::IAppender
    {
    public:
        explicit PlogArmarXAppender(std::string tag = "PLOG");
 
        void write(const plog::Record& record) override;
 
    private:
        std::string tag;
    };
 
    /**
      Registers a process-wide PlogArmarXAppender with plog's default logger
      instance, so PLOG_* log statements from libraries such as Simox are
      forwarded into the ArmarX log. Safe to call multiple times; only
      registers once.
    */
    void RegisterPlogArmarXAppender();
 
} // namespace armarx
 
#endif // ARMARX_PLOG_SUPPORT