WRApplication
External kratos "application" for multiscale time integration.
Public Member Functions | Friends | List of all members
CheckpointID Class Reference

Class enapsulating data and functionality for uniquely identifying a Checkpoint or Snapshot. More...

Collaboration diagram for CheckpointID:

Public Member Functions

 CheckpointID () noexcept
 Default constructor initialized to null. More...
 
 CheckpointID (int step, int path) noexcept
 
 CheckpointID (CheckpointID &&) noexcept=default
 
 CheckpointID (const CheckpointID &) noexcept=default
 
int GetStep () const noexcept
 
int GetAnalysisPath () const noexcept
 

Friends

bool operator== (CheckpointID left, CheckpointID right) noexcept
 True if both ANALYSIS_PATH and STEP are identical across operands. More...
 
bool operator!= (CheckpointID left, CheckpointID right) noexcept
 True if ANALYSIS_PATH or STEP are not equal. More...
 
bool operator< (CheckpointID left, CheckpointID right) noexcept
 Lexicographical comparison on [STEP, ANALYSIS_PATH]. More...
 
std::ostream & operator<< (std::ostream &rStream, CheckpointID ID)
 

Detailed Description

Class enapsulating data and functionality for uniquely identifying a Checkpoint or Snapshot.

Constructor & Destructor Documentation

◆ CheckpointID() [1/4]

CheckpointID ( )
noexcept

Default constructor initialized to null.

◆ CheckpointID() [2/4]

CheckpointID ( int  step,
int  path 
)
noexcept
  • step. STEP
  • path: ANALYSIS_PATH

◆ CheckpointID() [3/4]

CheckpointID ( CheckpointID &&  )
defaultnoexcept

◆ CheckpointID() [4/4]

CheckpointID ( const CheckpointID &  )
defaultnoexcept

Member Function Documentation

◆ GetAnalysisPath()

int GetAnalysisPath ( ) const
noexcept
Returns
ANALYSIS_PATH.

◆ GetStep()

int GetStep ( ) const
noexcept
Returns
STEP.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( CheckpointID  left,
CheckpointID  right 
)
friend

True if ANALYSIS_PATH or STEP are not equal.

◆ operator<

bool operator< ( CheckpointID  left,
CheckpointID  right 
)
friend

Lexicographical comparison on [STEP, ANALYSIS_PATH].

◆ operator<<

std::ostream& operator<< ( std::ostream &  rStream,
CheckpointID  ID 
)
friend

◆ operator==

bool operator== ( CheckpointID  left,
CheckpointID  right 
)
friend

True if both ANALYSIS_PATH and STEP are identical across operands.

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