Public Member Functions | Static Public Member Functions | Friends | List of all members
sigStopAtWriteNow Class Reference

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

Public Member Functions

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

Static Public Member Functions

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

Friends

class addstopAtWriteNowSignalToOpt
 Allow setter access to signal_. More...
 

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.

◆ sigStopAtWriteNow() [2/2]

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

Construct with Time reference.

Definition at line 107 of file sigStopAtWriteNow.C.

References runTime, and runTimePtr_.

◆ ~sigStopAtWriteNow()

~sigStopAtWriteNow ( )

Destructor.

Definition at line 116 of file sigStopAtWriteNow.C.

References Foam::resetHandler().

Here is the call graph for this function:

Member Function Documentation

◆ active()

static bool active ( )
inlinestaticnoexcept

Is active?

Definition at line 102 of file sigStopAtWriteNow.H.

◆ signalNumber()

static int signalNumber ( )
inlinestaticnoexcept

Signal number being used.

Definition at line 107 of file sigStopAtWriteNow.H.

◆ set()

void set ( bool  verbose = false)
static

Set/reset signal handler.

Definition at line 129 of file sigStopAtWriteNow.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::setHandler(), and sigWriteNow::signalNumber().

Referenced by addstopAtWriteNowSignalToOpt::readData().

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

Friends And Related Function Documentation

◆ addstopAtWriteNowSignalToOpt

friend class addstopAtWriteNowSignalToOpt
friend

Allow setter access to signal_.

Definition at line 75 of file sigStopAtWriteNow.H.

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