SPH
Public Member Functions | List of all members
NullLogWriter Class Reference

Helper writer that does not write any logs. More...

#include <LogWriter.h>

Inheritance diagram for NullLogWriter:
ILogWriter PeriodicTrigger ITrigger Polymorphic

Public Member Functions

 NullLogWriter ()
 
virtual void write (const Storage &storage, const Statistics &stats) override
 Writes to the log using provided storage and statistics. More...
 
- Public Member Functions inherited from ILogWriter
 ILogWriter (const SharedPtr< ILogger > &logger, const Float period=0._f)
 Constructs the log file. More...
 
virtual AutoPtr< ITriggeraction (Storage &storage, Statistics &stats) override final
 Writes to the log using provided storage and statistics. More...
 
- Public Member Functions inherited from PeriodicTrigger
 PeriodicTrigger (const Float period, const Float startTime)
 period Period in simulation time of triggered action. More...
 
virtual TriggerEnum type () const override
 Returns the type of the trigger. More...
 
virtual bool condition (const Storage &UNUSED(storage), const Statistics &stats) override
 
- Public Member Functions inherited from ITrigger
virtual bool condition (const Storage &storage, const Statistics &stats)=0
 Returns true if the trigger should be executed. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Additional Inherited Members

- Protected Attributes inherited from ILogWriter
SharedPtr< ILoggerlogger
 

Detailed Description

Helper writer that does not write any logs.

Use this to disable logging of statistics during run.

Definition at line 93 of file LogWriter.h.

Constructor & Destructor Documentation

◆ NullLogWriter()

NullLogWriter::NullLogWriter ( )

Definition at line 167 of file LogWriter.cpp.

Member Function Documentation

◆ write()

void NullLogWriter::write ( const Storage storage,
const Statistics stats 
)
overridevirtual

Writes to the log using provided storage and statistics.

Used for const-correctness (loggers should not modify storage nor stats) and returning another (non-nullptr) trigger (loggers do not create more triggers).

Implements ILogWriter.

Definition at line 170 of file LogWriter.cpp.


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