graph::writer Class Referenceabstract

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

Inheritance diagram for graph::writer:

Public Member Functions

 TypeName ("writer")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, writer, word,(),())
 Declare run-time constructor selection table. More...
 
 writer ()
 Construct null. More...
 
virtual ~writer ()
 Destructor. More...
 
virtual const wordext () const =0
 Return the appropriate fileName extension. 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 184 of file graph.H.

Constructor & Destructor Documentation

◆ writer()

writer ( )
inline

Construct null.

Definition at line 224 of file graph.H.

◆ ~writer()

virtual ~writer ( )
inlinevirtual

Destructor.

Definition at line 229 of file graph.H.

References format(), Foam::name(), graph::operator<<, path(), graph::wordify(), graph::write(), and graph::writeTable().

Here is the call graph for this function:

Member Function Documentation

◆ writeXY()

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

Definition at line 193 of file graph.C.

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

Referenced by graph::writer::New().

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 164 of file graph.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and graph::writer::writeXY().

Referenced by graph::write(), and graph::y().

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

◆ ext()

virtual const word& ext ( ) const
pure virtual

Return the appropriate fileName extension.

for this graph format

Implemented in xmgrGraph, gnuplotGraph, jplotGraph, and rawGraph.

◆ write()

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

Write graph in appropriate format.

Implemented in xmgrGraph, gnuplotGraph, jplotGraph, and rawGraph.


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