tarch.plotter::pointdata::PointWriter Class Reference

Interface for all Plotters. More...

#include <PointWriter.h>

Inheritance diagram for tarch.plotter::pointdata::PointWriter:

Data Structures
class	PointDataWriter
	A writer to assign points a value. More...

Public Member Functions
virtual	~PointWriter ()=default
virtual bool	writeToFile ()=0
	Counterpart to close() on all the depending writers.
virtual bool	isOpen ()=0
virtual void	clear ()=0
	Clear the writer, i.e.
virtual int	plotPoint (const tarch::la::Vector< 2, double > &position)=0
virtual int	plotPoint (const tarch::la::Vector< 3, double > &position)=0
virtual PointDataWriter *	createPointDataWriter (const std::string &identifier, int recordsPerPoint)=0
	Caller has to destroy this instance manually.

Detailed Description

Interface for all Plotters.

Author

Tobias Weinzierl

Definition at line 23 of file PointWriter.h.

Constructor & Destructor Documentation

~PointWriter()

virtual tarch.plotter::pointdata::PointWriter::~PointWriter ( )

virtualdefault

Member Function Documentation

clear()

virtual void tarch.plotter::pointdata::PointWriter::clear ( )

pure virtual

Clear the writer, i.e.

erase all the data. However, as the writer does not track how many vertex and cell writers you've created, it's up to you to ensure that none of these instances is left.

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

Referenced by peano4.api.output.Makefile.Makefile::__init__().

Here is the caller graph for this function:

createPointDataWriter()

virtual PointDataWriter * tarch.plotter::pointdata::PointWriter::createPointDataWriter ( const std::string &  identifier, int  recordsPerPoint  )

pure virtual

Caller has to destroy this instance manually.

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

isOpen()

virtual bool tarch.plotter::pointdata::PointWriter::isOpen ( )

pure virtual

Returns

Whether writer is ready to accept data.

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

plotPoint() [1/2]

virtual int tarch.plotter::pointdata::PointWriter::plotPoint ( const tarch::la::Vector< 2, double > &  position )

pure virtual

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

plotPoint() [2/2]

virtual int tarch.plotter::pointdata::PointWriter::plotPoint ( const tarch::la::Vector< 3, double > &  position )

pure virtual

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

writeToFile()

virtual bool tarch.plotter::pointdata::PointWriter::writeToFile ( )

pure virtual

Counterpart to close() on all the depending writers.

Implemented in tarch.plotter::pointdata::vtk::VTKWriter.

---

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

• src/tarch/plotter/pointdata/PointWriter.h