Arcane::ICheckpointReader Class Reference

Interface for the protection/recovery reading service. More...

#include <arcane/core/ICheckpointReader.h>

Inheritance diagram for Arcane::ICheckpointReader:

Collaboration diagram for Arcane::ICheckpointReader:

Public Member Functions
virtual	~ICheckpointReader ()=default
	Frees resources.
virtual IDataReader *	dataReader ()=0
	Returns the associated reader.
virtual void	notifyBeginRead ()=0
	Notifies that a protection will be read with current parameters.
virtual void	notifyEndRead ()=0
	Notifies that a protection has just been read.
virtual void	setFileName (const String &file_name)=0
	Sets the name of the protection file.
virtual String	fileName () const =0
	Name of the protection file.
virtual void	setBaseDirectoryName (const String &dirname)=0
	Sets the name of the protection base directory.
virtual String	baseDirectoryName () const =0
	Name of the protection base directory.
virtual void	setReaderMetaData (const String &)=0
	Metadata associated with this reader.
virtual void	setCurrentTimeAndIndex (Real current_time, Integer current_index)=0
	Sets the time and index of the protection to read.

Detailed Description

Interface for the protection/recovery reading service.

Definition at line 32 of file ICheckpointReader.h.

Member Function Documentation

baseDirectoryName()

virtual String Arcane::ICheckpointReader::baseDirectoryName ( ) const

pure virtual

Name of the protection base directory.

Implemented in Arcane::CheckpointService.

dataReader()

virtual IDataReader * Arcane::ICheckpointReader::dataReader ( )

pure virtual

Returns the associated reader.

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

fileName()

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

pure virtual

Name of the protection file.

Implemented in Arcane::CheckpointService.

notifyBeginRead()

virtual void Arcane::ICheckpointReader::notifyBeginRead ( )

pure virtual

Notifies that a protection will be read with current parameters.

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

notifyEndRead()

virtual void Arcane::ICheckpointReader::notifyEndRead ( )

pure virtual

Notifies that a protection has just been read.

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

setBaseDirectoryName()

virtual void Arcane::ICheckpointReader::setBaseDirectoryName ( const String & dirname )

pure virtual

Sets the name of the protection base directory.

Implemented in Arcane::CheckpointService.

setCurrentTimeAndIndex()

virtual void Arcane::ICheckpointReader::setCurrentTimeAndIndex ( Real current_time, Integer current_index )

pure virtual

Sets the time and index of the protection to read.

Implemented in Arcane::CheckpointService.

setFileName()

virtual void Arcane::ICheckpointReader::setFileName ( const String & file_name )

pure virtual

Sets the name of the protection file.

Implemented in Arcane::CheckpointService.

setReaderMetaData()

virtual void Arcane::ICheckpointReader::setReaderMetaData ( const String & )

pure virtual

Metadata associated with this reader.

Implemented in Arcane::CheckpointService.

---

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

• ICheckpointReader.h