Diffpack Documentation

---

              Search  

---

SimRes2bob Class Reference

class for exporting simres data to. More...

#include <SimRes2bob.h>

Inheritance diagram for SimRes2bob::

List of all members.

Public Methods
	SimRes2bob ()
	~SimRes2bob ()
virtual void	usage ()
virtual void	simresHeader (PlotSpecifications &plotspec)
virtual void	simresFooter (PlotSpecifications &plotspec)
virtual void	processFormatSpecificOptions (VecSimple(String) &arguments, PlotSpecifications &plotspec)
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.

NAME: SimRes2bob - class for exporting simres data to

DESCRIPTION:

This class filters data in SimRes format to the format used by the visualization program "Bob" (Brick of Bytes).

---

Constructor & Destructor Documentation

SimRes2bob::SimRes2bob ( )

See class "SimResFilter".

SimRes2bob::~SimRes2bob ( ) [inline]

---

Member Function Documentation

void SimRes2bob::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 SimRes2bob::exportVectorField ( Fields & vectorfield, FieldInformation & fieldinfo, PlotSpecifications & plotspec ) [virtual]

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

void SimRes2bob::processFormatSpecificOptions ( VecSimple(String) & arguments, PlotSpecifications & plotspec ) [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 SimRes2bob::simresFooter ( PlotSpecifications & plotspec ) [virtual]

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

void SimRes2bob::simresHeader ( PlotSpecifications & plotspec ) [virtual]

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

void SimRes2bob::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:

• SimRes2bob.h

---