Dune::Fem::ASCIIOutStream Class Reference

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

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

Inheritance diagram for Dune::Fem::ASCIIOutStream:

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
	ASCIIOutStream (const std::string &filename)
	constructor
	~ASCIIOutStream ()
	destructor
void	flush ()
	flush the stream
void	writeDouble (const double value)
	write a double to the stream
void	writeFloat (const float value)
	write a float to the stream
void	writeInt (const int value)
	write an int to the stream
void	writeSignedInt64 (int64_t value)
	write an int64_t to the stream
void	writeChar (const char value)
	write a char to the stream
void	writeBool (const bool value)
	write a char to the stream
void	writeString (const std::string &s)
	write a string to the stream
void	writeUnsignedInt (unsigned int value)
	write an unsigned int to the stream
void	writeUnsignedInt64 (uint64_t value)
	write an uint64_t to the stream

Protected Member Functions
bool	valid () const
void	writeError () const
const Implementation &	asImp () const
Implementation &	asImp ()

Static Protected Member Functions
static const Implementation &	asImp (const ThisType &other)
static Implementation &	asImp (ThisType &other)
static const Implementation &	asImp (const ThisType &other)
static Implementation &	asImp (ThisType &other)

Protected Attributes
std::ostream &	stream_
bool	mustFreeStream_

Related Symbols
(Note that these are not member symbols.)
OutStreamInterface< StreamTraits > &	operator<< (OutStreamInterface< StreamTraits > &out, const DiscreteFunctionInterface< Impl > &df)
	write a discrete function into an output stream

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:

Member Typedef Documentation

OutStreamInterfaceType

typedef ThisType Dune::Fem::OutStreamInterface< ASCIIOutStreamTraits >::OutStreamInterfaceType

inherited

type of the interface

OutStreamType

typedef Traits::OutStreamType Dune::Fem::OutStreamInterface< ASCIIOutStreamTraits >::OutStreamType

inherited

type of the implementation (Barton-Nackman)

Traits

typedef ASCIIOutStreamTraits Dune::Fem::ASCIIOutStream::Traits

type of the traits

Constructor & Destructor Documentation

ASCIIOutStream() [1/2]

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

inlineexplicit

constructor

Parameters

[in]

stream

STL output stream to write to

ASCIIOutStream() [2/2]

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

inlineexplicit

constructor

Parameters

[in]

filename

name of a file to write to

~ASCIIOutStream()

Dune::Fem::ASCIIOutStream::~ASCIIOutStream ( )

inline

destructor

Member Function Documentation

asImp() [1/6]

Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( )

inlineprotectedinherited

asImp() [2/6]

const Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ) const

inlineprotectedinherited

asImp() [3/6]

static const Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( const ThisType &  other )

inlinestaticprotectedinherited

asImp() [4/6]

template<class Interface , class Implementation >

static const Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( const ThisType &  other )

inlinestaticprotectedinherited

asImp() [5/6]

static Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ThisType &  other )

inlinestaticprotectedinherited

asImp() [6/6]

template<class Interface , class Implementation >

static Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ThisType &  other )

inlinestaticprotectedinherited

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)

valid()

bool Dune::Fem::ASCIIOutStream::valid ( ) const

inlineprotected

writeBool()

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

inline

write a char to the stream

Parameters

[in]

value

value to write to the stream

writeChar()

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

inline

write a char to the stream

Parameters

[in]

value

value to write to the stream

writeDouble()

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

inline

write a double to the stream

Parameters

[in]

value

value to write to the stream

writeError()

void Dune::Fem::OutStreamInterface< ASCIIOutStreamTraits >::writeError ( ) const

inlineprotectedinherited

writeFloat()

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

inline

write a float to the stream

Parameters

[in]

value

value to write to the stream

writeInt()

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

inline

write an int to the stream

Parameters

[in]

value

value to write to the stream

writeSignedInt64()

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

inline

write an int64_t to the stream

Parameters

[in]

value

value to write to the stream

writeString()

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

inline

write a string to the stream

Parameters

[in]

s

string to write to the stream

Note

Strings containing newline characters will not be read back correctly.

writeUnsignedInt()

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

inline

write an unsigned int to the stream

Parameters

[in]

value

value to write to the stream

writeUnsignedInt64()

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

inline

write an uint64_t to the stream

Parameters

[in]

value

value to write to the stream

Friends And Related Symbol Documentation

operator<<()

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

related

write a discrete function into an output stream

Parameters

[in]	out	stream to write to
[in]	df	discrete function to write

Returns

the output stream (for concatenation)

Member Data Documentation

mustFreeStream_

bool Dune::Fem::ASCIIOutStream::mustFreeStream_

protected

stream_

std::ostream& Dune::Fem::ASCIIOutStream::stream_

protected

---

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

• asciistreams.hh