graph::writer Class Referenceabstract

Abstract base class for a graph writer. More...

Inheritance diagram for graph::writer:
[legend]

Public Member Functions

 TypeName ("writer")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, writer, word,(),())
 Declare run-time constructor selection table. More...
 
 writer ()=default
 Default construct. More...
 
virtual ~writer ()=default
 Destructor. More...
 
virtual word ext () const =0
 The fileName extension for this graph format. More...
 
virtual void write (const graph &, Ostream &) const =0
 Write graph in appropriate format. More...
 

Static Public Member Functions

static autoPtr< writerNew (const word &writeFormat)
 Return a reference to the selected writer. More...
 

Protected Member Functions

void writeXY (const scalarField &x, const scalarField &y, Ostream &) const
 

Detailed Description

Abstract base class for a graph writer.

Definition at line 185 of file graph.H.

Constructor & Destructor Documentation

◆ writer()

writer ( )
default

Default construct.

◆ ~writer()

virtual ~writer ( )
virtualdefault

Destructor.

Member Function Documentation

◆ writeXY()

void writeXY ( const scalarField x,
const scalarField y,
Ostream os 
) const
protected

Definition at line 237 of file graph.C.

References Foam::endl(), forAll, os(), Foam::setw(), token::SPACE, x, and y.

Referenced by gnuplotWriter::write(), and xmgraceWriter::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "writer"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
writer  ,
word  ,
()  ,
()   
)

Declare run-time constructor selection table.

◆ New()

Foam::autoPtr< Foam::graph::writer > New ( const word writeFormat)
static

Return a reference to the selected writer.

Definition at line 209 of file graph.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and FatalErrorInLookup.

Here is the call graph for this function:

◆ ext()

virtual word ext ( ) const
pure virtual

The fileName extension for this graph format.

Implemented in gnuplotWriter, rawWriter, and xmgraceWriter.

◆ write()

virtual void write ( const graph ,
Ostream  
) const
pure virtual

Write graph in appropriate format.

Implemented in gnuplotWriter, rawWriter, and xmgraceWriter.


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