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

Interface for a curve writer. More...

#include <arcane/core/ITimeHistoryCurveWriter2.h>

Public Member Functions

virtual ~ITimeHistoryCurveWriter2 ()=default
 Release resources.
virtual void build ()=0
virtual void beginWrite (const TimeHistoryCurveWriterInfo &infos)=0
 Notify the start of writing.
virtual void endWrite ()=0
 Notify the end of writing.
virtual void writeCurve (const TimeHistoryCurveInfo &infos)=0
 Write a curve.
virtual String name () const =0
 Writer name.
virtual void setOutputPath (const String &path)=0
 Base directory where curves will be written.
virtual String outputPath () const =0
 Base directory where curves will be written.

Detailed Description

Interface for a curve writer.

When writing curves, the instance will be called as follows:

ITimeHistoryCurveWriter2* instance = ...;
instance->beginWrite();
for( const TimeHistoryCurveInfo& curveinfo : all_curves )
instance->writeCurve(curveinfo);
instance->endWrite()
virtual void endWrite()=0
Notify the end of writing.
virtual void beginWrite(const TimeHistoryCurveWriterInfo &infos)=0
Notify the start of writing.
virtual void writeCurve(const TimeHistoryCurveInfo &infos)=0
Write a curve.
Information for writing a curve.

Definition at line 172 of file ITimeHistoryCurveWriter2.h.

Member Function Documentation

◆ setOutputPath()

virtual void Arcane::ITimeHistoryCurveWriter2::setOutputPath ( const String & path)
pure virtual

Base directory where curves will be written.

If null, the directory specified during beginWrite() will be used.

◆ writeCurve()

virtual void Arcane::ITimeHistoryCurveWriter2::writeCurve ( const TimeHistoryCurveInfo & infos)
pure virtual

Write a curve.

Curve info is provided by infos Values are in the array values. times and iterations contain respectively the time and the iteration number for each value. path contains the directory where the curves will be written


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