dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Related Functions | List of all members
Dune::Fem::StandardInStream Class Reference

input stream reading from a given std::istream More...

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

Inheritance diagram for Dune::Fem::StandardInStream:
Inheritance graph

Public Types

typedef StandardInStreamTraits 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

 StandardInStream (std::istream &stream)
 constructor
 
std::istream & stream ()
 
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 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
 
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
 
template<class T >
void readPrimitive (T &value)
 
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_
 

Related Functions

(Note that these are not member functions.)

InStreamInterface< StreamTraits > & operator>> (InStreamInterface< StreamTraits > &in, DiscreteFunctionInterface< Impl > &df)
 read a discrete function from an input stream
 

Detailed Description

input stream reading from a given std::istream

Note
This stream directly stores the binary representation of the data. The binary representation of the stored data is always little endian. On read the data is converted accordingly on machines with different endianess.
Newly added:

Member Typedef Documentation

◆ InStreamInterfaceType

typedef ThisType Dune::Fem::InStreamInterface< StandardInStreamTraits >::InStreamInterfaceType
inherited

type of the interface

◆ InStreamType

type of the implementation (Barton-Nackman)

◆ Traits

type of the traits

Constructor & Destructor Documentation

◆ StandardInStream()

Dune::Fem::StandardInStream::StandardInStream ( std::istream &  stream)
inlineexplicit

constructor

Parameters
[in]streamstd::istream to read from

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< StandardInStreamTraits >::readBool ( )
inlineinherited

read a bool from the stream

Returns
a bool read from the stream

◆ readBool() [2/2]

void Dune::Fem::StandardInStream::readBool ( bool &  value)
inline

read a bool from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readChar() [1/2]

int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readChar ( )
inlineinherited

read a char from the stream

Returns
a char read from the stream

◆ readChar() [2/2]

void Dune::Fem::StandardInStream::readChar ( char &  value)
inline

read a char from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readDouble() [1/2]

double Dune::Fem::InStreamInterface< StandardInStreamTraits >::readDouble ( )
inlineinherited

read a double from the stream

Returns
a double read from the stream

◆ readDouble() [2/2]

void Dune::Fem::StandardInStream::readDouble ( double &  value)
inline

read a double from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readError()

void Dune::Fem::InStreamInterface< StandardInStreamTraits >::readError ( ) const
inlineprotectedinherited

◆ readFloat() [1/2]

float Dune::Fem::InStreamInterface< StandardInStreamTraits >::readFloat ( )
inlineinherited

read a double from the stream

Returns
a double read from the stream

◆ readFloat() [2/2]

void Dune::Fem::StandardInStream::readFloat ( float &  value)
inline

read a float from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readInt() [1/2]

int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readInt ( )
inlineinherited

read an int from the stream

Returns
an int read from the stream

◆ readInt() [2/2]

void Dune::Fem::StandardInStream::readInt ( int &  value)
inline

read an int from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readPrimitive()

template<class T >
void Dune::Fem::StandardInStream::readPrimitive ( T &  value)
inlineprotected

◆ readString()

void Dune::Fem::StandardInStream::readString ( std::string &  s)
inline

read a string from the stream

Parameters
[out]sreference to the string to read from the stream

◆ readUnsignedInt() [1/2]

unsigned int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readUnsignedInt ( )
inlineinherited

read an unsigned int from the stream

Returns
an unsigned int read from the stream

◆ readUnsignedInt() [2/2]

void Dune::Fem::StandardInStream::readUnsignedInt ( unsigned int &  value)
inline

read an unsigned int from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ readUnsignedInt64() [1/2]

uint64_t Dune::Fem::InStreamInterface< StandardInStreamTraits >::readUnsignedInt64 ( )
inlineinherited

read an uint64_t from the stream

Returns
an uint64_t read from the stream

◆ readUnsignedInt64() [2/2]

void Dune::Fem::StandardInStream::readUnsignedInt64 ( uint64_t &  value)
inline

read an uint64_t from the stream

Parameters
[out]valuereference to the variable to read from the stream

◆ stream()

std::istream & Dune::Fem::StandardInStream::stream ( )
inline

return reference to internal istream

◆ valid()

bool Dune::Fem::StandardInStream::valid ( ) const
inlineprotected

Friends And Related Function Documentation

◆ operator>>()

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

read a discrete function from an input stream

Parameters
[in]instream to read from
[out]dfdiscrete function to read
Returns
the input stream (for concatenation)

Member Data Documentation

◆ stream_

std::istream& Dune::Fem::StandardInStream::stream_
protected

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