Arcane::ITimeHistoryCurveWriter2 Class Reference

Interface for a curve writer. More...

#include <arcane/core/ITimeHistoryCurveWriter2.h>

Inheritance diagram for Arcane::ITimeHistoryCurveWriter2:

Collaboration diagram for Arcane::ITimeHistoryCurveWriter2:

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()

Definition at line 172 of file ITimeHistoryCurveWriter2.h.

Member Function Documentation

beginWrite()

virtual void Arcane::ITimeHistoryCurveWriter2::beginWrite ( const TimeHistoryCurveWriterInfo & infos )

pure virtual

Notify the start of writing.

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

Referenced by Arcane::TimeHistoryMngInternal::dumpCurves().

Here is the caller graph for this function:

build()

virtual void Arcane::ITimeHistoryCurveWriter2::build ( )

pure virtual

Implemented in Arcane::ArcaneCurveWriter.

endWrite()

virtual void Arcane::ITimeHistoryCurveWriter2::endWrite ( )

pure virtual

Notify the end of writing.

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

Referenced by Arcane::TimeHistoryMngInternal::dumpCurves().

Here is the caller graph for this function:

name()

virtual String Arcane::ITimeHistoryCurveWriter2::name ( ) const

pure virtual

Writer name.

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

Referenced by Arcane::TimeHistoryMngInternal::_dumpCurvesAllWriters(), and Arcane::TimeHistoryMng2::removeCurveWriter().

Here is the caller graph for this function:

outputPath()

virtual String Arcane::ITimeHistoryCurveWriter2::outputPath ( ) const

pure virtual

Base directory where curves will be written.

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

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.

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

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

Implemented in Arcane::ArcaneCurveWriter, and Arcane::GnuplotTimeHistoryCurveWriter2.

Referenced by Arcane::TimeHistoryMngInternal::dumpCurves(), and Arcane::TimeHistoryValueT< DataType >::dumpValues().

Here is the caller graph for this function:

---

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

• ITimeHistoryCurveWriter2.h