Loading...
Searching...
No Matches
sigStopAtWriteNow Class Reference

Signal handler to write and stop the job. The interrupt is defined by OptimisationSwitches::stopAtWriteNowSignal. More...

#include <sigStopAtWriteNow.H>

Public Member Functions

 sigStopAtWriteNow () noexcept=default
 Default construct.
 sigStopAtWriteNow (const Time &runTime, bool verbose=false)
 Construct with Time reference.
 ~sigStopAtWriteNow ()
 Destructor.

Static Public Member Functions

static bool active () noexcept
 Is active?
static int signalNumber () noexcept
 Signal number being used.
static void set (bool verbose=false)
 Set/reset signal handler.

Friends

class addstopAtWriteNowSignalToOpt
 Allow setter access to signal_.

Detailed Description

Signal handler to write and stop the job. The interrupt is defined by OptimisationSwitches::stopAtWriteNowSignal.

Source files
See also
Foam::JobInfo

Definition at line 52 of file sigStopAtWriteNow.H.

Constructor & Destructor Documentation

◆ sigStopAtWriteNow() [1/2]

sigStopAtWriteNow ( )
defaultnoexcept

Default construct.

References Foam::noexcept.

Referenced by sigStopAtWriteNow(), and ~sigStopAtWriteNow().

Here is the caller graph for this function:

◆ sigStopAtWriteNow() [2/2]

sigStopAtWriteNow ( const Time & runTime,
bool verbose = false )
explicit

Construct with Time reference.

References runTime, and sigStopAtWriteNow().

Here is the call graph for this function:

◆ ~sigStopAtWriteNow()

~sigStopAtWriteNow ( )

Destructor.

References sigStopAtWriteNow().

Here is the call graph for this function:

Member Function Documentation

◆ active()

bool active ( )
inlinestaticnoexcept

Is active?

Definition at line 102 of file sigStopAtWriteNow.H.

References active(), and Foam::noexcept.

Referenced by active().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ signalNumber()

int signalNumber ( )
inlinestaticnoexcept

Signal number being used.

Definition at line 107 of file sigStopAtWriteNow.H.

References Foam::noexcept.

◆ set()

void set ( bool verbose = false)
static

Set/reset signal handler.

◆ addstopAtWriteNowSignalToOpt

friend class addstopAtWriteNowSignalToOpt
friend

Allow setter access to signal_.

Definition at line 75 of file sigStopAtWriteNow.H.

References addstopAtWriteNowSignalToOpt.

Referenced by addstopAtWriteNowSignalToOpt.

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