Diffpack Documentation

---

              Search  

---

SimRes2summary Class Reference

class for exporting simres data to a summary format. More...

#include <SimRes2summary.h>

Inheritance diagram for SimRes2summary::

List of all members.

Public Methods
	SimRes2summary ()
	~SimRes2summary ()
virtual void	usage ()
virtual void	simresHeader (PlotSpecifications &)
virtual void	simresFooter (PlotSpecifications &)
virtual void	processFormatSpecificOptions (VecSimple(String) &, PlotSpecifications &)
virtual void	exportScalarField (Field &scalarfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)
virtual void	exportVectorField (Fields &vectorfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)

---

Detailed Description

class for exporting simres data to a summary format.

NAME: SimRes2summary - class for exporting simres data to a summary format

DESCRIPTION:

This class filters data in SimRes format to a summary format used for compact reporting and testing.

---

Constructor & Destructor Documentation

SimRes2summary::SimRes2summary ( )

See class "SimResFilter".

SimRes2summary::~SimRes2summary ( ) [inline]

---

Member Function Documentation

void SimRes2summary::exportScalarField ( Field & scalarfield, FieldInformation & fieldinfo, PlotSpecifications & plotspec ) [virtual]

export a scalar field to a file format that can be read by a specific visualization program. Reimplemented from SimResFilter.

void SimRes2summary::exportVectorField ( Fields & vectorfield, FieldInformation & fieldinfo, PlotSpecifications & plotspec ) [virtual]

as "exportScalarField", but handles vector fields instead. Reimplemented from SimResFilter.

void SimRes2summary::processFormatSpecificOptions ( VecSimple(String) & arguments, PlotSpecifications & plotspec ) [inline, virtual]

process remaining command line arguments in derived classes (after "SimResFilter driver" has processed the arguments that are common to all filters). Reimplemented from SimResFilter.

void SimRes2summary::simresFooter ( PlotSpecifications & plotspec ) [virtual]

task to be done just before exiting the filter. Reimplemented from SimResFilter.

void SimRes2summary::simresHeader ( PlotSpecifications & plotspec ) [inline, virtual]

task to be done once initially, after processing of command line args (in "driver"). Reimplemented from SimResFilter.

void SimRes2summary::usage ( ) [virtual]

description of various command line arguments. The command line arguments that are common to all filters are explained in "SimResFilter usage" and processed in "SimResFilter driver". Additional command line arguments can be explained in the "usage" function in derived classes and processed in the "processFormatSpecificOptions" function in the derived class. Reimplemented from SimResFilter.

---

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

• SimRes2summary.h

---