input stream reading from an STL input stream using ASCII decoding More...

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

Inheritance diagram for Dune::Fem::ASCIIInStream:

Public Types
typedef ASCIIInStreamTraits	Traits
	type of the traits

typedef Traits::InStreamType	InStreamType
	type of the implementation (Barton-Nackman)

typedef ThisType	InStreamInterfaceType
	type of the interface

Public Member Functions
	ASCIIInStream (std::istream &stream)
	constructor

	ASCIIInStream (const std::string &filename)
	constructor

	~ASCIIInStream ()
	destructor

void	readDouble (double &value)
	read a double from the stream

void	readFloat (float &value)
	read a float from the stream

void	readInt (int &value)
	read an int from the stream

void	readSignedInt64 (int64_t &value)
	read an int64_t from the stream

void	readChar (char &value)
	read a char from the stream

void	readBool (bool &value)
	read a bool from the stream

void	readString (std::string &s)
	read a string from the stream

void	readUnsignedInt (unsigned int &value)
	read an unsigned int from the stream

void	readUnsignedInt64 (uint64_t &value)
	read an uint64_t from the stream

double	readDouble ()
	read a double from the stream

float	readFloat ()
	read a double from the stream

int	readInt ()
	read an int from the stream

int64_t	readSignedInt64 ()
	read an int64_t from the stream

int	readChar ()
	read a char from the stream

bool	readBool ()
	read a bool from the stream

unsigned int	readUnsignedInt ()
	read an unsigned int from the stream

uint64_t	readUnsignedInt64 ()
	read an uint64_t from the stream

Protected Member Functions
bool	valid () const

void	readError () 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::istream &	stream_

bool	mustFreeStream_

Related Symbols
(Note that these are not member symbols.)
InStreamInterface< StreamTraits > &	operator>> (InStreamInterface< StreamTraits > &in, DiscreteFunctionInterface< Impl > &df)
	read a discrete function from an input stream

Detailed Description

input stream reading from an STL input stream using ASCII decoding

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

◆ InStreamInterfaceType

typedef ThisType Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::InStreamInterfaceType

inherited

type of the interface

◆ InStreamType

typedef Traits::InStreamType Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::InStreamType

inherited

type of the implementation (Barton-Nackman)

◆ Traits

typedef ASCIIInStreamTraits Dune::Fem::ASCIIInStream::Traits

type of the traits

Constructor & Destructor Documentation

◆ ASCIIInStream() [1/2]

Dune::Fem::ASCIIInStream::ASCIIInStream ( std::istream & stream )

inlineexplicit

constructor

Parameters

[in] stream STL output stream to write to

◆ ASCIIInStream() [2/2]

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

inline

constructor

Parameters

[in] filename name of a file to write to

◆ ~ASCIIInStream()

Dune::Fem::ASCIIInStream::~ASCIIInStream ( )

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

◆ readBool() [1/2]

bool Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readBool ( )

inlineinherited

read a bool from the stream

Returns: a bool read from the stream

◆ readBool() [2/2]

void Dune::Fem::ASCIIInStream::readBool ( bool & value )

inline

read a bool from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readChar() [1/2]

int Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readChar ( )

inlineinherited

read a char from the stream

Returns: a char read from the stream

◆ readChar() [2/2]

void Dune::Fem::ASCIIInStream::readChar ( char & value )

inline

read a char from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readDouble() [1/2]

double Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readDouble ( )

inlineinherited

read a double from the stream

Returns: a double read from the stream

◆ readDouble() [2/2]

void Dune::Fem::ASCIIInStream::readDouble ( double & value )

inline

read a double from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readError()

void Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readError ( ) const

inlineprotectedinherited

◆ readFloat() [1/2]

float Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readFloat ( )

inlineinherited

read a double from the stream

Returns: a double read from the stream

◆ readFloat() [2/2]

void Dune::Fem::ASCIIInStream::readFloat ( float & value )

inline

read a float from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readInt() [1/2]

int Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readInt ( )

inlineinherited

read an int from the stream

Returns: an int read from the stream

◆ readInt() [2/2]

void Dune::Fem::ASCIIInStream::readInt ( int & value )

inline

read an int from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readSignedInt64() [1/2]

int64_t Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readSignedInt64 ( )

inlineinherited

read an int64_t from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readSignedInt64() [2/2]

void Dune::Fem::ASCIIInStream::readSignedInt64 ( int64_t & value )

inline

read an int64_t from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readString()

void Dune::Fem::ASCIIInStream::readString ( std::string & s )

inline

read a string from the stream

Parameters

[out] s reference to the string to read from the stream

Note: Strings containing newline characters will not be read back correctly.

◆ readUnsignedInt() [1/2]

unsigned int Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readUnsignedInt ( )

inlineinherited

read an unsigned int from the stream

Returns: an unsigned int read from the stream

◆ readUnsignedInt() [2/2]

void Dune::Fem::ASCIIInStream::readUnsignedInt ( unsigned int & value )

inline

read an unsigned int from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readUnsignedInt64() [1/2]

uint64_t Dune::Fem::InStreamInterface< ASCIIInStreamTraits >::readUnsignedInt64 ( )

inlineinherited

read an uint64_t from the stream

Returns: an uint64_t read from the stream

◆ readUnsignedInt64() [2/2]

void Dune::Fem::ASCIIInStream::readUnsignedInt64 ( uint64_t & value )

inline

read an uint64_t from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ valid()

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

inlineprotected

Friends And Related Symbol Documentation

◆ operator>>()

InStreamInterface< StreamTraits > & operator>>	(	InStreamInterface< StreamTraits > &	in,
		DiscreteFunctionInterface< Impl > &	df
	)

Parameters

[in]	in	stream to read from
[out]	df	discrete function to read

Returns: the input stream (for concatenation)

Member Data Documentation

◆ mustFreeStream_

bool Dune::Fem::ASCIIInStream::mustFreeStream_

protected

◆ stream_

std::istream& Dune::Fem::ASCIIInStream::stream_

protected

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

asciistreams.hh

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Related Symbols

Detailed Description

Member Typedef Documentation

◆ InStreamInterfaceType

◆ InStreamType

◆ Traits

Constructor & Destructor Documentation

◆ ASCIIInStream() [1/2]

◆ ASCIIInStream() [2/2]

◆ ~ASCIIInStream()

Member Function Documentation

◆ asImp() [1/6]

◆ asImp() [2/6]

◆ asImp() [3/6]

◆ asImp() [4/6]

◆ asImp() [5/6]

◆ asImp() [6/6]

◆ readBool() [1/2]

◆ readBool() [2/2]

◆ readChar() [1/2]

◆ readChar() [2/2]

◆ readDouble() [1/2]

◆ readDouble() [2/2]

◆ readError()

◆ readFloat() [1/2]

◆ readFloat() [2/2]

◆ readInt() [1/2]

◆ readInt() [2/2]

◆ readSignedInt64() [1/2]

◆ readSignedInt64() [2/2]

◆ readString()

◆ readUnsignedInt() [1/2]

◆ readUnsignedInt() [2/2]

◆ readUnsignedInt64() [1/2]

◆ readUnsignedInt64() [2/2]

◆ valid()

Friends And Related Symbol Documentation

◆ operator>>()

Member Data Documentation

◆ mustFreeStream_

◆ stream_