legacyAsciiFormatter Class Reference

Formatting as per Foam::vtk::asciiFormatter, but with naming for legacy output. More...

Inheritance diagram for legacyAsciiFormatter:
[legend]
Collaboration diagram for legacyAsciiFormatter:
[legend]

Public Member Functions

 legacyAsciiFormatter (std::ostream &os)
 Construct and attach to an output stream, use default precision. More...
 
 legacyAsciiFormatter (std::ostream &os, unsigned precision)
 Construct and attach to an output stream, use specified precision. More...
 
virtual ~legacyAsciiFormatter ()=default
 Destructor. More...
 
virtual const outputOptionsopts () const
 The output is LEGACY_ASCII. More...
 
virtual const char * name () const
 Name for the legacy ascii output type ("ASCII") More...
 
virtual const char * encoding () const
 Name for the XML append encoding (unused). More...
 
virtual formatterendTag (vtk::fileTag)
 An end XML tag with sanity check. More...
 
virtual formatterendDataArray ()
 End "DataArray" XML section. More...
 
virtual formatterendFieldData ()
 End "FieldData" XML section. More...
 
virtual formatterendCellData ()
 End "CellData" XML section. More...
 
virtual formatterendPointData ()
 End "PointData" XML section. More...
 
virtual formatterendPiece ()
 End "Piece" XML section. More...
 
virtual formatterendVTKFile ()
 End "VTKFile" XML section. More...
 
- Public Member Functions inherited from asciiFormatter
 asciiFormatter (std::ostream &os)
 Construct and attach to an output stream, use default precision. More...
 
 asciiFormatter (std::ostream &os, unsigned precision)
 Construct and attach to an output stream, use specified precision. More...
 
virtual ~asciiFormatter ()
 Destructor. Finishes the output line as required. More...
 
virtual bool writeSize (const uint64_t ignored)
 Write leading size - this is a no-op for ascii output. More...
 
virtual void write (const uint8_t val)
 
virtual void write (const label val)
 
virtual void write (const float val)
 
virtual void write (const double val)
 
virtual void flush ()
 Write a newline if needed to finish a line of output. More...
 
virtual std::size_t encodedLength (std::size_t ignored) const
 The encoded length for ascii output is not applicable. More...
 
- Public Member Functions inherited from formatter
virtual ~formatter ()=default
 Destructor. More...
 
std::ostream & os ()
 Access to the underlying output stream. More...
 
void quoting (const quoteChar quote)
 Change quoting char for XML attributes (default: SINGLE_QUOTE) More...
 
virtual uint64_t offset (const uint64_t numbytes)
 Increase the append data offset by numbytes and sizeof(uint64_t). More...
 
void indent ()
 Add indenting according to the current XML tag depth. More...
 
void indent (label n)
 Add indenting of n spaces. More...
 
formatterxmlHeader ()
 Write XML header. More...
 
template<class... Args>
formatterxmlComment (const std::string &text, Args &&... args)
 Write XML comment (at the current indentation level) More...
 
template<class... Args>
formatteropenTag (const word &tagName, Args &&... args)
 Start an XML tag, optionally with attributes. More...
 
template<class... Args>
formatteropenTag (vtk::fileTag t, Args &&... args)
 Start an XML tag, optionally with attributes. More...
 
formattercloseTag (const bool isEmpty=false)
 Finish an XML tag, optional as an empty container. More...
 
formatterendTag (const word &tagName=word::null)
 An end XML tag, optional with sanity check. More...
 
template<class... Args>
formattertag (const word &t, Args &&... args)
 Write XML tag without any attributes. Combines openTag/closeTag. More...
 
template<class... Args>
formattertag (vtk::fileTag t, Args &&... args)
 Write XML tag without any attributes. Combines openTag/closeTag. More...
 
formatterbeginVTKFile (const word &contentType, const word &contentVersion, const bool leaveOpen=false)
 
formatterbeginVTKFile (vtk::fileTag contentType, const word &contentVersion, const bool leaveOpen=false)
 
formatterbeginVTKFile (vtk::fileTag contentType, const bool leaveOpen=false)
 
template<vtk::fileTag ContentType>
formatterbeginVTKFile (bool leaveOpen=false)
 
formatterbeginAppendedData ()
 
formatterbeginBlock (label index, std::string name="")
 Begin "Block" XML section. More...
 
formatterendBlock ()
 End "Block" XML section. More...
 
formatterbeginPiece (label index, std::string name="")
 Begin "Piece" XML section. More...
 
formatterDataSet (label index, std::string file="", bool autoName=true)
 Insert a single "DataSet" XML entry tag. More...
 
formatterDataSet (label index, std::string file, std::string name)
 Insert a single "DataSet" XML entry tag. More...
 
template<class Type , direction nComp = 1, int nTuple = 0>
formatterbeginDataArray (const word &dataName, uint64_t payLoad=npos, bool leaveOpen=false)
 Begin "DataArray" XML section. More...
 
template<class Type , direction nComp = 1, int nTuple = 0>
formatterbeginDataArray (const vtk::dataArrayAttr &dataName, uint64_t payLoad=npos, bool leaveOpen=false)
 Begin "DataArray" XML section. More...
 
template<class Type , direction nComp = 1, int nTuple = 0>
formatterPDataArray (const word &dataName)
 Insert a single "PDataArray" XML entry tag. More...
 
formatterbeginFieldData ()
 Begin "FieldData" XML section. More...
 
formatterbeginCellData ()
 Begin "CellData" XML section. More...
 
formatterbeginPointData ()
 Begin "PointData" XML section. More...
 
formatterendAppendedData ()
 End "AppendedData" XML section. More...
 
formatterwriteTimeValue (scalar timeValue)
 Emit "TimeValue" for FieldData (name as per Catalyst output) More...
 
template<class... Args>
formatterxmlAttr (const word &k, const std::string &v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const word &k, const int32_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const word &k, const int64_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const word &k, const uint64_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const word &k, const scalar v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const vtk::fileAttr &k, const std::string &v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const vtk::fileAttr &k, const int32_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const vtk::fileAttr &k, const int64_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const vtk::fileAttr &k, const uint64_t v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class... Args>
formatterxmlAttr (const vtk::fileAttr &k, const scalar v, Args &&... args)
 Pair-wise write of XML key/value attributes. More...
 
template<class Type , direction nComp = 1, int nTuple = 0>
formatteropenDataArray (const word &dataName)
 Open "DataArray" XML tag and leave open (requires a closeTag). More...
 
template<class Type , direction nComp = 1, int nTuple = 0>
formatteropenDataArray (const vtk::dataArrayAttr &dataName)
 Open "DataArray" XML tag and leave open (requires a closeTag). More...
 
template<class... Args>
Foam::vtk::formatterxmlComment (const std::string &text, Args &&... args)
 
template<class... Args>
Foam::vtk::formatteropenTag (const word &tagName, Args &&... args)
 
template<class... Args>
Foam::vtk::formatteropenTag (vtk::fileTag t, Args &&... args)
 
template<class... Args>
Foam::vtk::formattertag (const word &t, Args &&... args)
 
template<class... Args>
Foam::vtk::formattertag (vtk::fileTag t, Args &&... args)
 
template<Foam::vtk::fileTag ContentType>
Foam::vtk::formatterbeginVTKFile (bool leaveOpen)
 
template<class Type , Foam::direction nComp, int nTuple>
Foam::vtk::formatterbeginDataArray (const vtk::dataArrayAttr &dataName, uint64_t payLoad, bool leaveOpen)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const word &k, const std::string &v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const word &k, const int32_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const word &k, const int64_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const word &k, const uint64_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const word &k, const scalar v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const vtk::fileAttr &k, const std::string &v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const vtk::fileAttr &k, const int32_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const vtk::fileAttr &k, const int64_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const vtk::fileAttr &k, const uint64_t v, Args &&... args)
 
template<class... Args>
Foam::vtk::formatterxmlAttr (const vtk::fileAttr &k, const scalar v, Args &&... args)
 
template<class Type , Foam::direction nComp, int nTuple>
Foam::vtk::formatterbeginDataArray (const word &dataName, uint64_t payLoad, bool leaveOpen)
 
template<class Type , Foam::direction nComp, int nTuple>
Foam::vtk::formatterPDataArray (const word &dataName)
 

Additional Inherited Members

- Public Types inherited from formatter
enum  quoteChar : char { DOUBLE_QUOTE = '\"', SINGLE_QUOTE = '\'' }
 Quoting for XML attributes. More...
 
typedef uint64_t headerType
 The header data is vtk UInt64. More...
 
- Static Public Attributes inherited from formatter
static constexpr uint64_t npos = uint64_t(-1)
 Out of range position or size. More...
 
- Protected Member Functions inherited from formatter
bool canWriteAttr (const word &k) const
 
bool canWriteToplevel (const char *what) const
 
template<class Type >
void writeAttr (const word &k, const Type &v)
 Write XML key/value attribute pair (implementation). More...
 
formatterxmlAttr ()
 No-op write XML attribute (for templating code). More...
 
void xmlCommentLoop ()
 No-op XML comment loop (for templating code). More...
 
template<class... Args>
void xmlCommentLoop (const std::string &text, Args &&... args)
 Loop/output XML comments. More...
 
bool openTagImpl (const word &tagName)
 
 formatter (std::ostream &os)
 Construct and attach to an output stream. More...
 
- Protected Attributes inherited from formatter
std::ostream & os_
 The output stream for the formatter. More...
 
DynamicList< wordxmlTags_
 LIFO stack of current XML tags. More...
 
bool inTag_
 Tag open/closed/ended state. More...
 
char quote_
 Quoting character for XML attributes. More...
 

Detailed Description

Formatting as per Foam::vtk::asciiFormatter, but with naming for legacy output.

Source files

Definition at line 53 of file foamVtkLegacyAsciiFormatter.H.

Constructor & Destructor Documentation

◆ legacyAsciiFormatter() [1/2]

legacyAsciiFormatter ( std::ostream &  os)

Construct and attach to an output stream, use default precision.

Definition at line 42 of file foamVtkLegacyAsciiFormatter.C.

◆ legacyAsciiFormatter() [2/2]

legacyAsciiFormatter ( std::ostream &  os,
unsigned  precision 
)

Construct and attach to an output stream, use specified precision.

Definition at line 51 of file foamVtkLegacyAsciiFormatter.C.

◆ ~legacyAsciiFormatter()

virtual ~legacyAsciiFormatter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ opts()

const Foam::vtk::outputOptions & opts ( ) const
virtual

The output is LEGACY_ASCII.

Reimplemented from asciiFormatter.

Definition at line 63 of file foamVtkLegacyAsciiFormatter.C.

◆ name()

const char * name ( ) const
virtual

Name for the legacy ascii output type ("ASCII")

Reimplemented from asciiFormatter.

Definition at line 69 of file foamVtkLegacyAsciiFormatter.C.

◆ encoding()

const char * encoding ( ) const
virtual

Name for the XML append encoding (unused).

Currently identical to name(), but do not rely on this.

Reimplemented from asciiFormatter.

Definition at line 75 of file foamVtkLegacyAsciiFormatter.C.

◆ endTag()

virtual formatter& endTag ( vtk::fileTag  t)
inlinevirtual

An end XML tag with sanity check.

Always adds a trailing newline.

Returns
formatter for chaining

Reimplemented from formatter.

Definition at line 102 of file foamVtkLegacyAsciiFormatter.H.

◆ endDataArray()

virtual formatter& endDataArray ( )
inlinevirtual

End "DataArray" XML section.

Returns
formatter for chaining

Reimplemented from formatter.

Definition at line 103 of file foamVtkLegacyAsciiFormatter.H.

◆ endFieldData()

virtual formatter& endFieldData ( )
inlinevirtual

End "FieldData" XML section.

Reimplemented from formatter.

Definition at line 104 of file foamVtkLegacyAsciiFormatter.H.

◆ endCellData()

virtual formatter& endCellData ( )
inlinevirtual

End "CellData" XML section.

Reimplemented from formatter.

Definition at line 105 of file foamVtkLegacyAsciiFormatter.H.

◆ endPointData()

virtual formatter& endPointData ( )
inlinevirtual

End "PointData" XML section.

Reimplemented from formatter.

Definition at line 106 of file foamVtkLegacyAsciiFormatter.H.

◆ endPiece()

virtual formatter& endPiece ( )
inlinevirtual

End "Piece" XML section.

Returns
formatter for chaining

Reimplemented from formatter.

Definition at line 107 of file foamVtkLegacyAsciiFormatter.H.

◆ endVTKFile()

virtual formatter& endVTKFile ( )
inlinevirtual

End "VTKFile" XML section.

Returns
formatter for chaining

Reimplemented from formatter.

Definition at line 108 of file foamVtkLegacyAsciiFormatter.H.


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