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

Trigger executing given action every period. More...

#include <Trigger.h>

Inheritance diagram for PeriodicTrigger:
ITrigger Polymorphic AngularMomentumLog DiagnosticsTrigger ILogWriter ProgressLog ProgressLogger BriefLogWriter EnergyLogWriter IntegralsLogWriter LogWriter NullLogWriter StandardLogWriter VerboseLogWriter

Public Member Functions

 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...
 
virtual AutoPtr< ITriggeraction (Storage &storage, Statistics &stats)=0
 Action executed when the condition is fulfilled. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Trigger executing given action every period.

Definition at line 37 of file Trigger.h.

Constructor & Destructor Documentation

◆ PeriodicTrigger()

PeriodicTrigger::PeriodicTrigger ( const Float  period,
const Float  startTime 
)
inlineexplicit

period Period in simulation time of triggered action.

Definition at line 44 of file Trigger.h.

Member Function Documentation

◆ condition()

virtual bool PeriodicTrigger::condition ( const Storage UNUSEDstorage,
const Statistics stats 
)
inlineoverridevirtual

Definition at line 52 of file Trigger.h.

◆ type()

virtual TriggerEnum PeriodicTrigger::type ( ) const
inlineoverridevirtual

Returns the type of the trigger.

Implements ITrigger.

Definition at line 48 of file Trigger.h.


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