FEAT 3
Finite Element Analysis Toolbox
Loading...
Searching...
No Matches
FEAT::Control::Checkpointable Class Referenceabstract

Checkpoint interface class. More...

#include <checkpoint_control.hpp>

Inheritance diagram for FEAT::Control::Checkpointable:
FEAT::Control::CheckpointableWrapper< Object_ >

Public Member Functions

virtual std::uint64_t get_checkpoint_size (LAFEM::SerialConfig &config)=0
 Calculate size. More...
 
virtual void restore_from_checkpoint_data (std::vector< char > &data)=0
 Extract object from checkpoint. More...
 
virtual std::uint64_t set_checkpoint_data (std::vector< char > &data, LAFEM::SerialConfig &config)=0
 Collect checkpoint data from object. More...
 

Detailed Description

Checkpoint interface class.

This abstract class provides the necessary interface for all checkpointable objects.

Definition at line 32 of file checkpoint_control.hpp.

Constructor & Destructor Documentation

◆ ~Checkpointable()

virtual FEAT::Control::Checkpointable::~Checkpointable ( )
inlineprotectedvirtual

Definition at line 66 of file checkpoint_control.hpp.

Member Function Documentation

◆ get_checkpoint_size()

virtual std::uint64_t FEAT::Control::Checkpointable::get_checkpoint_size ( LAFEM::SerialConfig config)
pure virtual

Calculate size.

Calculate size of complete object as it is stored in the checkpoint

Returns
size of object

Implemented in FEAT::Control::CheckpointableWrapper< Object_ >.

◆ restore_from_checkpoint_data()

virtual void FEAT::Control::Checkpointable::restore_from_checkpoint_data ( std::vector< char > &  data)
pure virtual

Extract object from checkpoint.

Restores complete object with all its contents from checkpoint data

Parameters
[out]dataobject as bytestrem

Implemented in FEAT::Control::CheckpointableWrapper< Object_ >.

◆ set_checkpoint_data()

virtual std::uint64_t FEAT::Control::Checkpointable::set_checkpoint_data ( std::vector< char > &  data,
LAFEM::SerialConfig config 
)
pure virtual

Collect checkpoint data from object.

Adds the condensed complete object with all its contents to the end of the checkpoint buffer

Parameters
[out]dataobject as bytestream

Implemented in FEAT::Control::CheckpointableWrapper< Object_ >.


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