Arcane::ICheckpointWriter Class Reference

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

#include <arcane/core/ICheckpointWriter.h>

Inheritance diagram for Arcane::ICheckpointWriter:

Collaboration diagram for Arcane::ICheckpointWriter:

Public Member Functions
virtual	~ICheckpointWriter ()=default
	Releases resources.
virtual IDataWriter *	dataWriter ()=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< Real >	checkpointTimes () 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();

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.

Referenced by Arcane::CheckpointMng::_writeCheckpointInfoFile().

Here is the caller graph for this function:

checkpointTimes()

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

pure virtual

Checkpoint times.

Implemented in Arcane::CheckpointService.

Referenced by Arcane::CheckpointMng::_writeCheckpointInfoFile().

Here is the caller graph for this function:

close()

virtual void Arcane::ICheckpointWriter::close ( )

pure virtual

Closes the checkpoints.

Implemented in Arcane::ArcaneBasicCheckpointService, and Arcane::ArcaneHdf5CheckpointService2.

dataWriter()

virtual IDataWriter * Arcane::ICheckpointWriter::dataWriter ( )

pure virtual

Returns the associated writer.

Implemented in Arcane::ArcaneBasicCheckpointService, and Arcane::ArcaneHdf5CheckpointService2.

fileName()

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

pure virtual

Name of the checkpoint file.

Implemented in Arcane::CheckpointService.

notifyBeginWrite()

virtual void Arcane::ICheckpointWriter::notifyBeginWrite ( )

pure virtual

Notifies that a checkpoint is going to be written with the current parameters.

Implemented in Arcane::ArcaneBasicCheckpointService, and Arcane::ArcaneHdf5CheckpointService2.

notifyEndWrite()

virtual void Arcane::ICheckpointWriter::notifyEndWrite ( )

pure virtual

Notifies that a checkpoint has just been written.

Implemented in Arcane::ArcaneBasicCheckpointService, and Arcane::ArcaneHdf5CheckpointService2.

readerMetaData()

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

pure virtual

Metadata for the reader associated with this writer.

Implemented in Arcane::CheckpointService.

Referenced by Arcane::CheckpointMng::_writeCheckpointInfoFile().

Here is the caller graph for this function:

readerServiceName()

virtual String Arcane::ICheckpointWriter::readerServiceName ( ) const

pure virtual

Name of the reader service associated with this writer.

Implemented in Arcane::ArcaneBasic2CheckpointService, Arcane::ArcaneBasicCheckpointService, and Arcane::ArcaneHdf5CheckpointService2.

Referenced by Arcane::CheckpointMng::_writeCheckpointInfoFile().

Here is the caller graph for this function:

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:

• ICheckpointWriter.h