xmgrGraph.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::xmgrGraph
26 
27 Description
28  Output and \b agr file for \em xmgrace
29  (http://plasma-gate.weizmann.ac.il/Grace/)
30 
31 SourceFiles
32  xmgrGraph.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef xmgrGraph_H
37 #define xmgrGraph_H
38 
39 #include "graph.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class xmgrGraph Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class xmgrGraph
51 :
52  public graph::writer
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("xmgr");
59 
60  //- FileName extension for this graph format
61  static const word ext_;
62 
63 
64  // Constructors
65 
66  //- Construct null
67  xmgrGraph()
68  {}
69 
70 
71  //- Destructor
72  ~xmgrGraph()
73  {}
74 
75 
76  // Member Functions
77 
78  // Access
79 
80  //- Return the appropriate fileName extension
81  // for this graph format
82  const word& ext() const
83  {
84  return ext_;
85  }
86 
87 
88  // Write
89 
90  void write(const graph&, Ostream& os) const;
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Output and agr file for xmgrace (http://plasma-gate.weizmann.ac.il/Grace/)
Definition: xmgrGraph.H:49
void write(const graph &, Ostream &os) const
Write graph in appropriate format.
Definition: xmgrGraph.C:43
~xmgrGraph()
Destructor.
Definition: xmgrGraph.H:71
Abstract base class for a graph writer.
Definition: graph.H:184
Class to create, store and output qgraph files.
Definition: graph.H:58
A class for handling words, derived from string.
Definition: word.H:59
static const word ext_
FileName extension for this graph format.
Definition: xmgrGraph.H:60
const word & ext() const
Return the appropriate fileName extension.
Definition: xmgrGraph.H:81
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
xmgrGraph()
Construct null.
Definition: xmgrGraph.H:66
TypeName("xmgr")
Runtime type information.
Namespace for OpenFOAM.