foamVtkBase64Formatter.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2016-2022 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::vtk::base64Formatter
28
29Description
30 Inline base-64 encoded binary output.
31 Uses an output filter layer to write base-64 encoded content.
32
33\*---------------------------------------------------------------------------*/
34
35#ifndef Foam_vtk_base64Formatter_H
36#define Foam_vtk_base64Formatter_H
37
38#include "foamVtkFormatter.H"
39#include "foamVtkBase64Layer.H"
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45namespace vtk
46{
47
48/*---------------------------------------------------------------------------*\
49 Class vtk::base64Formatter Declaration
50\*---------------------------------------------------------------------------*/
53:
55{
56 // Private Data Members
57
58 static const char* name_;
59 static const outputOptions opts_;
60
61
62 // Private Member Functions
63
64 //- No copy construct
65 base64Formatter(const base64Formatter&) = delete;
66
67 //- No copy assignment
68 void operator=(const base64Formatter&) = delete;
69
70
71public:
72
73 // Constructors
74
75 //- Construct and attach to an output stream
76 explicit base64Formatter(std::ostream& os);
77
78
79 //- Destructor. Closes/flushes the underlying layer.
80 virtual ~base64Formatter();
81
82
83 // Member Functions
84
85 //- The output is INLINE_BASE64.
86 virtual const vtk::outputOptions& opts() const;
87
88 //- Name for the XML output type ("binary")
89 virtual const char* name() const;
90
91
92 //- End the encoding sequence (padding the final characters with '=')
93 // and write a newline to the output if any encoding was done.
94 virtual void flush();
95};
96
97
98// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100} // End namespace vtk
101} // End namespace Foam
102
103// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105#endif
106
107// ************************************************************************* //
Inline base-64 encoded binary output. Uses an output filter layer to write base-64 encoded content.
virtual const vtk::outputOptions & opts() const
The output is INLINE_BASE64.
virtual const char * name() const
Name for the XML output type ("binary")
virtual ~base64Formatter()
Destructor. Closes/flushes the underlying layer.
virtual void flush()
End the encoding sequence (padding the final characters with '=')
Base-64 encoded output layer - normally only used indirectly by formatters.
std::ostream & os() noexcept
Access to the underlying output stream.
Encapsulated combinations of output format options. This is primarily useful when defining the output...
Namespace for OpenFOAM.