SPH
Public Member Functions | List of all members
EnergyLogWriter Class Reference
Inheritance diagram for EnergyLogWriter:
ILogWriter PeriodicTrigger ITrigger Polymorphic

Public Member Functions

 ILogWriter (const SharedPtr< ILogger > &logger, const Float period=0._f)
 Constructs the log file. 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

Todo:
generailize, add generic triggers to UI

Definition at line 13 of file SimulationJobs.cpp.

Member Function Documentation

◆ ILogWriter()

NAMESPACE_SPH_BEGIN ILogWriter::ILogWriter
explicit

Constructs the log file.

This base class actually does not use the logger in any way, it is stored there (and required in the constructor) because all derived classes are expected to use a logger; this way we can reduce the code duplication.

Parameters
loggerLogger for the written data. Must not be nullptr.
periodLog period in run time. Must be a positive value or zero; zero period means the log message is written on every time step.

Definition at line 23 of file LogWriter.cpp.


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