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

Writer logging useful statistics (current run time, relative progress, time step, ...). More...

#include <LogWriter.h>

Inheritance diagram for StandardLogWriter:
ILogWriter PeriodicTrigger ITrigger Polymorphic VerboseLogWriter

Public Member Functions

 StandardLogWriter (const SharedPtr< ILogger > &logger, const RunSettings &settings)
 
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

Writer logging useful statistics (current run time, relative progress, time step, ...).

This is the default writer used in the simulation.

Definition at line 40 of file LogWriter.h.

Constructor & Destructor Documentation

◆ StandardLogWriter()

StandardLogWriter::StandardLogWriter ( const SharedPtr< ILogger > &  logger,
const RunSettings settings 
)

Definition at line 37 of file LogWriter.cpp.

Member Function Documentation

◆ write()

void StandardLogWriter::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.

Reimplemented in VerboseLogWriter.

Definition at line 42 of file LogWriter.cpp.


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