Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::IBackwardMng Class Referenceabstract

Public Types

enum  eAction { Save , Restore }

Public Member Functions

virtual void init ()=0
 Initialization of the backward manager.
virtual void beginAction ()=0
 Indicates that the save/restore actions have started.
virtual bool checkAndApplyRestore ()=0
 Checks and applies restoration if necessary.
virtual bool checkAndApplySave (bool is_forced)=0
 Checks and applies variable saving if necessary. If is_forced is true, forces the save.
virtual void endAction ()=0
 Indicates that the save/restore actions are finished.
virtual void setSavePeriod (Integer n)=0
virtual Integer savePeriod () const =0
virtual void goBackward ()=0
 Signals that a backward rollback is desired.
virtual bool isLocked () const =0
 Indicates if the backward rollback saves are locked.
virtual bool isBackwardEnabled () const =0
 Indicates if a backward rollback is scheduled.
virtual void clear ()=0
 Deletes resources associated with the backward rollback.

Detailed Description

Definition at line 53 of file IBackwardMng.h.

Member Enumeration Documentation

◆ eAction

Enumerator
Save 

Save.

Restore 

Restore.

Definition at line 58 of file IBackwardMng.h.

Member Function Documentation

◆ checkAndApplyRestore()

virtual bool Arcane::IBackwardMng::checkAndApplyRestore ( )
pure virtual

Checks and applies restoration if necessary.

Return values
trueif a restoration is performed.

◆ checkAndApplySave()

virtual bool Arcane::IBackwardMng::checkAndApplySave ( bool is_forced)
pure virtual

Checks and applies variable saving if necessary. If is_forced is true, forces the save.

Return values
trueif a save is performed.

◆ clear()

virtual void Arcane::IBackwardMng::clear ( )
pure virtual

Deletes resources associated with the backward rollback.

This method is called to deallocate resources such as variable saves. This method is called among other things before a load balancing because it will not be possible to perform a backward rollback before this balancing.

◆ goBackward()

virtual void Arcane::IBackwardMng::goBackward ( )
pure virtual

Signals that a backward rollback is desired.

The backward rollback will occur when checkAndApplyRestore() is called.

Generally, this method should not be called directly but rather ITimeLoopMng::goBackward().

From the call to this method until the effective action of the backward rollback when calling checkAndApplyRestore(), isBackwardEnabled() returns true.

◆ isBackwardEnabled()

virtual bool Arcane::IBackwardMng::isBackwardEnabled ( ) const
pure virtual

Indicates if a backward rollback is scheduled.

See also
goBackward().

◆ isLocked()

virtual bool Arcane::IBackwardMng::isLocked ( ) const
pure virtual

Indicates if the backward rollback saves are locked.

isLocked() is true if it is not possible to perform a save. This is the case, for example, when a backward rollback has been performed at iteration M to iteration N and we have not yet returned to iteration M.


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