DUNE-FEM (unstable)

Dune::Fem::ASCIIOutStream Class Reference

output stream writing into an STL output stream using ASCII encoding More...

#include <dune/fem/io/streams/asciistreams.hh>

Public Types

typedef ASCIIOutStreamTraits Traits
 type of the traits
 
typedef Traits::OutStreamType OutStreamType
 type of the implementation (Barton-Nackman)
 
typedef ThisType OutStreamInterfaceType
 type of the interface
 

Public Member Functions

 ASCIIOutStream (std::ostream &stream)
 constructor More...
 
 ASCIIOutStream (const std::string &filename)
 constructor More...
 
 ~ASCIIOutStream ()
 destructor
 
void flush ()
 flush the stream More...
 
void writeDouble (const double value)
 write a double to the stream More...
 
void writeFloat (const float value)
 write a float to the stream More...
 
void writeInt (const int value)
 write an int to the stream More...
 
void writeSignedInt64 (int64_t value)
 write an int64_t to the stream More...
 
void writeChar (const char value)
 write a char to the stream More...
 
void writeBool (const bool value)
 write a char to the stream More...
 
void writeString (const std::string &s)
 write a string to the stream More...
 
void writeUnsignedInt (unsigned int value)
 write an unsigned int to the stream More...
 
void writeUnsignedInt64 (uint64_t value)
 write an uint64_t to the stream More...
 

Related Functions

(Note that these are not member functions.)

OutStreamInterface< StreamTraits > & operator<< (OutStreamInterface< StreamTraits > &out, const DiscreteFunctionInterface< Impl > &df)
 write a discrete function into an output stream More...
 

Detailed Description

output stream writing into an STL output stream using ASCII encoding

This writes the data into an STL output stream. The data is written in ASCII format, each basic type on a single line.

Newly added:

Constructor & Destructor Documentation

◆ ASCIIOutStream() [1/2]

Dune::Fem::ASCIIOutStream::ASCIIOutStream ( std::ostream &  stream)
inlineexplicit

constructor

Parameters
[in]streamSTL output stream to write to

◆ ASCIIOutStream() [2/2]

Dune::Fem::ASCIIOutStream::ASCIIOutStream ( const std::string &  filename)
inlineexplicit

constructor

Parameters
[in]filenamename of a file to write to

Member Function Documentation

◆ flush()

void Dune::Fem::ASCIIOutStream::flush ( )
inline

flush the stream

By calling the flush method, the user can ensure that the stream is actually transferred (e.g., written to disk)

◆ writeBool()

void Dune::Fem::ASCIIOutStream::writeBool ( const bool  value)
inline

write a char to the stream

Parameters
[in]valuevalue to write to the stream

References writeString().

◆ writeChar()

void Dune::Fem::ASCIIOutStream::writeChar ( const char  value)
inline

write a char to the stream

Parameters
[in]valuevalue to write to the stream

References writeInt().

◆ writeDouble()

void Dune::Fem::ASCIIOutStream::writeDouble ( const double  value)
inline

write a double to the stream

Parameters
[in]valuevalue to write to the stream

◆ writeFloat()

void Dune::Fem::ASCIIOutStream::writeFloat ( const float  value)
inline

write a float to the stream

Parameters
[in]valuevalue to write to the stream

◆ writeInt()

void Dune::Fem::ASCIIOutStream::writeInt ( const int  value)
inline

write an int to the stream

Parameters
[in]valuevalue to write to the stream

Referenced by writeChar().

◆ writeSignedInt64()

void Dune::Fem::ASCIIOutStream::writeSignedInt64 ( int64_t  value)
inline

write an int64_t to the stream

Parameters
[in]valuevalue to write to the stream

◆ writeString()

void Dune::Fem::ASCIIOutStream::writeString ( const std::string &  s)
inline

write a string to the stream

Parameters
[in]sstring to write to the stream
Note
Strings containing newline characters will not be read back correctly.

Referenced by writeBool().

◆ writeUnsignedInt()

void Dune::Fem::ASCIIOutStream::writeUnsignedInt ( unsigned int  value)
inline

write an unsigned int to the stream

Parameters
[in]valuevalue to write to the stream

◆ writeUnsignedInt64()

void Dune::Fem::ASCIIOutStream::writeUnsignedInt64 ( uint64_t  value)
inline

write an uint64_t to the stream

Parameters
[in]valuevalue to write to the stream

Friends And Related Function Documentation

◆ operator<<()

OutStreamInterface< StreamTraits > & operator<< ( OutStreamInterface< StreamTraits > &  out,
const DiscreteFunctionInterface< Impl > &  df 
)
related

write a discrete function into an output stream

Parameters
[in]outstream to write to
[in]dfdiscrete function to write
Returns
the output stream (for concatenation)

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 21, 23:30, 2024)