Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Logging::OutputDecorator Class Reference

base class for decorating the debug output More...

#include <acts/blob/sPHENIX/Core/include/Acts/Utilities/Logger.hpp>

+ Inheritance diagram for Acts::Logging::OutputDecorator:
+ Collaboration diagram for Acts::Logging::OutputDecorator:

Public Member Functions

 OutputDecorator (std::unique_ptr< OutputPrintPolicy > wrappee)
 constructor wrapping actual output print policy
 
void flush (const Level &lvl, const std::string &input) override
 flush the debug message to the destination stream
 
const std::string & name () const override
 
- Public Member Functions inherited from Acts::Logging::OutputPrintPolicy
virtual ~OutputPrintPolicy ()=default
 virtual default destructor
 
virtual std::unique_ptr
< OutputPrintPolicy
clone (const std::string &name) const =0
 

Protected Attributes

std::unique_ptr
< OutputPrintPolicy
m_wrappee
 wrapped object for printing the debug message
 

Detailed Description

base class for decorating the debug output

Derived classes may augment the debug message with additional information. Chaining different decorators is possible to customize the output to your needs.

Definition at line 341 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 341 of file Logger.hpp

Constructor & Destructor Documentation

Acts::Logging::OutputDecorator::OutputDecorator ( std::unique_ptr< OutputPrintPolicy wrappee)
inlineexplicit

constructor wrapping actual output print policy

Parameters
[in]wrappeeoutput print policy object which is wrapped by this decorator object

Definition at line 347 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 347 of file Logger.hpp

Member Function Documentation

void Acts::Logging::OutputDecorator::flush ( const Level lvl,
const std::string &  input 
)
inlineoverridevirtual

flush the debug message to the destination stream

Parameters
[in]lvldebug level of debug message
[in]inputtext of debug message

This function delegates the flushing of the debug message to its wrapped object.

Implements Acts::Logging::OutputPrintPolicy.

Reimplemented in Acts::Logging::LevelOutputDecorator, Acts::Logging::ThreadOutputDecorator, Acts::Logging::TimedOutputDecorator, and Acts::Logging::NamedOutputDecorator.

Definition at line 357 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 357 of file Logger.hpp

References m_wrappee.

Referenced by Acts::Logging::NamedOutputDecorator::flush(), Acts::Logging::TimedOutputDecorator::flush(), Acts::Logging::ThreadOutputDecorator::flush(), and Acts::Logging::LevelOutputDecorator::flush().

+ Here is the caller graph for this function:

const std::string& Acts::Logging::OutputDecorator::name ( ) const
inlineoverridevirtual

Return the name of the output decorator (forwards to wrappee)

Returns
the name

Implements Acts::Logging::OutputPrintPolicy.

Reimplemented in Acts::Logging::NamedOutputDecorator.

Definition at line 363 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 363 of file Logger.hpp

References m_wrappee.

Member Data Documentation

std::unique_ptr<OutputPrintPolicy> Acts::Logging::OutputDecorator::m_wrappee
protected

wrapped object for printing the debug message

Definition at line 367 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 367 of file Logger.hpp

Referenced by Acts::Logging::NamedOutputDecorator::clone(), Acts::Logging::TimedOutputDecorator::clone(), Acts::Logging::ThreadOutputDecorator::clone(), Acts::Logging::LevelOutputDecorator::clone(), flush(), and name().


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