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

Public Member Functions

virtual void setBaseDirectoryName (const String &path)=0
 Sets the path of the directory containing the data.
virtual void setBaseFileName (const String &filename)=0
 Sets the name of the file containing the data.
virtual void initialize (bool is_start)=0
 Initializes the reader.
virtual void setVariables (VariableCollection vars)=0
 Sets the list of variables that we wish to reread. This call must happen before initialize().
virtual void updateVariables (Real wanted_time)=0
 Updates the variables for the time wanted_time.
virtual Real2 timeInterval (IVariable *var)=0
 Time interval of values for the variable var. The data for the variable var exists for the times included between a.x and a.y with a having the value returned.

Detailed Description

Definition at line 33 of file IVariableReader.h.

Member Function Documentation

◆ initialize()

virtual void Arcane::IVariableReader::initialize ( bool is_start)
pure virtual

Initializes the reader.

is_start is true if we are at the start of the calculation.

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.

◆ setBaseDirectoryName()

virtual void Arcane::IVariableReader::setBaseDirectoryName ( const String & path)
pure virtual

Sets the path of the directory containing the data.

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.

◆ setBaseFileName()

virtual void Arcane::IVariableReader::setBaseFileName ( const String & filename)
pure virtual

Sets the name of the file containing the data.

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.

◆ setVariables()

virtual void Arcane::IVariableReader::setVariables ( VariableCollection vars)
pure virtual

Sets the list of variables that we wish to reread. This call must happen before initialize().

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.

◆ timeInterval()

virtual Real2 Arcane::IVariableReader::timeInterval ( IVariable * var)
pure virtual

Time interval of values for the variable var. The data for the variable var exists for the times included between a.x and a.y with a having the value returned.

This call is valid only after calling initialize().

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.

◆ updateVariables()

virtual void Arcane::IVariableReader::updateVariables ( Real wanted_time)
pure virtual

Updates the variables for the time wanted_time.

Implemented in Arcane::ManualHdf5VariableReader, and Arcane::OldManualHdf5VariableReader.


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