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

Interface of the checkpoint/recovery write service. More...

#include <arcane/core/ICheckpointWriter.h>

Public Member Functions

virtual ~ICheckpointWriter ()=default
 Releases resources.
virtual IDataWriterdataWriter ()=0
 Returns the associated writer.
virtual void notifyBeginWrite ()=0
 Notifies that a checkpoint is going to be written with the current parameters.
virtual void notifyEndWrite ()=0
 Notifies that a checkpoint has just been written.
virtual void setFileName (const String &file_name)=0
 Sets the name of the checkpoint file.
virtual String fileName () const =0
 Name of the checkpoint file.
virtual void setBaseDirectoryName (const String &dirname)=0
 Sets the name of the checkpoint base directory.
virtual String baseDirectoryName () const =0
 Name of the checkpoint base directory.
virtual void setCheckpointTimes (RealConstArrayView times)=0
 Sets the checkpoint times.
virtual ConstArrayView< RealcheckpointTimes () const =0
 Checkpoint times.
virtual void close ()=0
 Closes the checkpoints.
virtual String readerServiceName () const =0
 Name of the reader service associated with this writer.
virtual String readerMetaData () const =0
 Metadata for the reader associated with this writer.

Detailed Description

Interface of the checkpoint/recovery write service.

The instance must return an IDataWriter (via dataWriter()) to handle the writing.

The sequence of functions is as follows:

ICheckpointWriter* checkpoint_writer = ...;
checkpoint_writer->setCheckpointTimes();
checkpoint_writer->notifyBeginWrite();
checkpoint_writer->dataWriter();
// ...
// Writing with the IDataWriter
// ...
checkpoint_writer->notifyBeginWrite();
checkpoint_writer->readerServiceName();
checkpoint_writer->readerMetaData();
Interface of the checkpoint/recovery write service.
virtual String readerServiceName() const =0
Name of the reader service associated with this writer.
virtual String readerMetaData() const =0
Metadata for the reader associated with this writer.
virtual void setCheckpointTimes(RealConstArrayView times)=0
Sets the checkpoint times.
virtual void notifyBeginWrite()=0
Notifies that a checkpoint is going to be written with the current parameters.
virtual IDataWriter * dataWriter()=0
Returns the associated writer.

Definition at line 49 of file ICheckpointWriter.h.

Member Function Documentation

◆ baseDirectoryName()

virtual String Arcane::ICheckpointWriter::baseDirectoryName ( ) const
pure virtual

Name of the checkpoint base directory.

Implemented in Arcane::CheckpointService.

◆ checkpointTimes()

virtual ConstArrayView< Real > Arcane::ICheckpointWriter::checkpointTimes ( ) const
pure virtual

Checkpoint times.

Implemented in Arcane::CheckpointService.

◆ fileName()

virtual String Arcane::ICheckpointWriter::fileName ( ) const
pure virtual

Name of the checkpoint file.

Implemented in Arcane::CheckpointService.

◆ readerMetaData()

virtual String Arcane::ICheckpointWriter::readerMetaData ( ) const
pure virtual

Metadata for the reader associated with this writer.

Implemented in Arcane::CheckpointService.

◆ setBaseDirectoryName()

virtual void Arcane::ICheckpointWriter::setBaseDirectoryName ( const String & dirname)
pure virtual

Sets the name of the checkpoint base directory.

Implemented in Arcane::CheckpointService.

◆ setCheckpointTimes()

virtual void Arcane::ICheckpointWriter::setCheckpointTimes ( RealConstArrayView times)
pure virtual

Sets the checkpoint times.

The time of the current checkpoint is the last element of the array

Implemented in Arcane::CheckpointService.

◆ setFileName()

virtual void Arcane::ICheckpointWriter::setFileName ( const String & file_name)
pure virtual

Sets the name of the checkpoint file.

Implemented in Arcane::CheckpointService.


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