A wrapped std::ifstream with possible compression handling (igzstream) that behaves much like a std::unique_ptr. More...

Inheritance diagram for ifstreamPointer:

[legend]

Public Member Functions
	ifstreamPointer () noexcept=default
	Default construct (empty) More...

	ifstreamPointer (const ifstreamPointer &)=delete
	No copy construct. More...

	ifstreamPointer (ifstreamPointer &&)=default
	Move construct. More...

void	operator= (const ifstreamPointer &)=delete
	No copy assignment. More...

ifstreamPointer &	operator= (ifstreamPointer &&)=default
	Move assignment. More...

	~ifstreamPointer ()=default
	Destructor. More...

	ifstreamPointer (const fileName &pathname)
	Construct from pathname. More...

	ifstreamPointer (const fileName &pathname, IOstreamOption streamOpt)
	Construct from pathname, option. More...

	operator bool () const noexcept
	True if it holds a valid pointer. More...

std::istream *	get () noexcept
	The stream pointer (ifstream or igzstream) More...

const std::istream *	get () const noexcept
	The stream pointer (ifstream or igzstream) More...

IOstreamOption::compressionType	whichCompression () const
	Which compression type? More...

void	open (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption())
	Attempts to open the specified file for reading. More...

std::istream *	release () noexcept
	Return managed pointer and release ownership. More...

void	reset (std::istream *ptr) noexcept
	Replace the managed pointer. More...

std::istream &	operator* ()
	Reference to the stream (no nullptr checking) More...

const std::istream &	operator* () const
	Const-reference to the stream (no nullptr checking) More...

std::istream *	operator-> () noexcept
	Pointer dereference. More...

const std::istream *	operator-> () const noexcept
	Pointer dereference. More...

Static Public Member Functions
static bool	supports_gz () noexcept
	True if compiled with libz support. More...

Protected Member Functions
void	reopen_gz (const std::string &pathname)
	Special 'rewind' method for compressed stream. More...

Detailed Description

A wrapped std::ifstream with possible compression handling (igzstream) that behaves much like a std::unique_ptr.

Note: No operator bool to avoid inheritance ambiguity with std::ios::operator bool.

Source files

Definition at line 70 of file fstreamPointer.H.

Constructor & Destructor Documentation

◆ ifstreamPointer() [1/5]

ifstreamPointer ( )

defaultnoexcept

Default construct (empty)

◆ ifstreamPointer() [2/5]

ifstreamPointer ( const ifstreamPointer & )

delete

No copy construct.

◆ ifstreamPointer() [3/5]

ifstreamPointer ( ifstreamPointer && )

default

Move construct.

◆ ~ifstreamPointer()

~ifstreamPointer ( )

default

Destructor.

◆ ifstreamPointer() [4/5]

ifstreamPointer ( const fileName & pathname )

explicit

Construct from pathname.

Attempts to read the specified file. If that fails, try as a compressed file (.gz ending).

Parameters

pathname The file name to open for reading

Definition at line 71 of file fstreamPointers.C.

◆ ifstreamPointer() [5/5]

ifstreamPointer	(	const fileName &	pathname,
		IOstreamOption	streamOpt
	)

Construct from pathname, option.

Attempts to read the specified file. If that fails, try as a compressed file (.gz ending).

Parameters

pathname	The file name to open for reading
streamOpt	Currently unused

Definition at line 59 of file fstreamPointers.C.

Member Function Documentation

◆ reopen_gz()

void reopen_gz ( const std::string & pathname )

protected

Special 'rewind' method for compressed stream.

Definition at line 359 of file fstreamPointers.C.

Referenced by IFstream::rewind().

Here is the caller graph for this function:

◆ operator=() [1/2]

void operator= ( const ifstreamPointer & )

delete

No copy assignment.

◆ operator=() [2/2]

ifstreamPointer& operator= ( ifstreamPointer && )

default

Move assignment.

◆ supports_gz()

bool supports_gz ( )

staticnoexcept

True if compiled with libz support.

Definition at line 36 of file fstreamPointers.C.

◆ operator bool()

operator bool ( ) const

inlineexplicitnoexcept

True if it holds a valid pointer.

Definition at line 164 of file fstreamPointer.H.

◆ get() [1/2]

std::istream* get ( )

inlinenoexcept

The stream pointer (ifstream or igzstream)

Definition at line 169 of file fstreamPointer.H.

Referenced by IFstream::fileSize(), IFstream::IFstream(), IFstream::rewind(), and IFstream::stdStream().

Here is the caller graph for this function:

◆ get() [2/2]

const std::istream* get ( ) const

inlinenoexcept

The stream pointer (ifstream or igzstream)

Definition at line 174 of file fstreamPointer.H.

◆ whichCompression()

Foam::IOstreamOption::compressionType whichCompression ( ) const

Which compression type?

Definition at line 496 of file fstreamPointers.C.

Referenced by STLCore::detectBinaryHeader(), IFstream::fileSize(), IFstream::IFstream(), STLCore::readBinaryHeader(), and IFstream::rewind().

Here is the caller graph for this function:

◆ open()

void open	(	const fileName &	pathname,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

Attempts to open the specified file for reading.

If that fails, try as a compressed file (.gz ending).

Parameters

pathname	The file name to open for reading
streamOpt	Currently unused

Definition at line 310 of file fstreamPointers.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, Foam::isFile(), and Foam::nl.

Here is the call graph for this function:

◆ release()

std::istream* release ( )

inlinenoexcept

Return managed pointer and release ownership.

Definition at line 203 of file fstreamPointer.H.

Referenced by STLCore::readBinaryHeader().

Here is the caller graph for this function:

◆ reset()

void reset ( std::istream * ptr )

inlinenoexcept

Replace the managed pointer.

Definition at line 208 of file fstreamPointer.H.

◆ operator*() [1/2]

std::istream& operator* ( )

inline

Reference to the stream (no nullptr checking)

Definition at line 216 of file fstreamPointer.H.

◆ operator*() [2/2]

const std::istream& operator* ( ) const

inline

Const-reference to the stream (no nullptr checking)

Definition at line 221 of file fstreamPointer.H.

◆ operator->() [1/2]

std::istream* operator-> ( )

inlinenoexcept

Pointer dereference.

Definition at line 226 of file fstreamPointer.H.

◆ operator->() [2/2]

const std::istream* operator-> ( ) const

inlinenoexcept

Pointer dereference.

Definition at line 231 of file fstreamPointer.H.

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

src/OpenFOAM/db/IOstreams/Fstreams/fstreamPointer.H
src/OpenFOAM/db/IOstreams/Fstreams/fstreamPointers.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ifstreamPointer() [1/5]

◆ ifstreamPointer() [2/5]

◆ ifstreamPointer() [3/5]

◆ ~ifstreamPointer()

◆ ifstreamPointer() [4/5]

◆ ifstreamPointer() [5/5]

Member Function Documentation

◆ reopen_gz()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ supports_gz()

◆ operator bool()

◆ get() [1/2]

◆ get() [2/2]

◆ whichCompression()

◆ open()

◆ release()

◆ reset()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]