FileInputStream Class Reference

Helper class that hands out input streams to a file. More...

#include <FileInputStream.h>

Inheritance diagram for FileInputStream:

Public Member Functions
	FileInputStream (const std::string &filename)
virtual std::shared_ptr< std::istream >	get () const override final
	Gets an input stream to the underlying stream. More...
virtual std::optional< std::filesystem::path >	getFilename () const override final
	Gets the underlying filename, if any. More...
bool	inUse () const
	Whether or not anything is still using this stream. More...

Protected Member Functions
void	addSharedStream (const std::weak_ptr< std::istream > stream) const
	Internal method to be called by derived classes to add a shared stream to _shared_streams (so that it can be tracked). More...

Protected Attributes
const std::filesystem::path	_filename
	The name of the file. More...

Detailed Description

Helper class that hands out input streams to a file.

Definition at line 17 of file FileInputStream.h.

Constructor & Destructor Documentation

FileInputStream()

FileInputStream::FileInputStream

(

const std::string &

filename

)

Definition at line 16 of file FileInputStream.C.

                                                           : InputStream(), _filename(filename)
{
}

Member Function Documentation

addSharedStream()

void InputStream::addSharedStream ( const std::weak_ptr< std::istream >  stream ) const

protectedinherited

Internal method to be called by derived classes to add a shared stream to _shared_streams (so that it can be tracked).

Should be called in the overridden get() by derived classes.

Definition at line 21 of file InputStream.C.

Referenced by get(), and StringInputStream::get().

{
  mooseAssert(!stream.expired(), "Stream is expired");

  for (auto & entry : _shared_streams)
    if (entry.expired())
    {
      entry = stream;
      return;
    }
  _shared_streams.push_back(stream);
}

get()

std::shared_ptr< std::istream > FileInputStream::get ( ) const

finaloverridevirtual

Gets an input stream to the underlying stream.

This is returned as a shared_ptr so that this class can tell whether or not another object is still using the stream.

Implements InputStream.

Definition at line 21 of file FileInputStream.C.

{
  std::shared_ptr<std::istream> stream = std::make_unique<std::ifstream>();
  addSharedStream(stream);

  auto & in = *static_cast<std::ifstream *>(stream.get());
  in.open(_filename.c_str(), std::ios::in | std::ios::binary);
  if (in.fail())
    mooseError("Unable to open file ", std::filesystem::absolute(_filename));

  return stream;
}

getFilename()

std::optional< std::filesystem::path > FileInputStream::getFilename ( ) const

finaloverridevirtual

Gets the underlying filename, if any.

Reimplemented from InputStream.

Definition at line 35 of file FileInputStream.C.

{
  return _filename;
}

inUse()

bool InputStream::inUse ( ) const

inherited

Whether or not anything is still using this stream.

This is checked by seeing whether or not the use count of any of the streams handed out by get() is > 1 (with the only use count being the one stored in _shared_streams)

Definition at line 35 of file InputStream.C.

Referenced by StringInputStream::release(), and InputStream::~InputStream().

{
  for (auto & stream : _shared_streams)
    if (!stream.expired())
      return true;
  return false;
}

Member Data Documentation

_filename

const std::filesystem::path FileInputStream::_filename

protected

The name of the file.

Definition at line 28 of file FileInputStream.h.

Referenced by get(), and getFilename().

---

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

• include/restart/FileInputStream.h
• src/restart/FileInputStream.C