dash::io::hdf5::InputStream Class Reference

Public Types
typedef IOStreamMode< IOStreamMode >	ios_mode_type

Public Member Functions
	InputStream (dash::launch lpolicy, std::string filename)
	Creates an HDF5 input stream using a launch policy. More...
	InputStream (std::string filename)
	Creates an HDF5 input stream using blocking IO. More...
	InputStream (const self_t &other)=delete
	InputStream (self_t &&other)=default
self_t &	operator= (const self_t &other)=delete
self_t &	operator= (self_t &&other)=default
InputStream &	flush ()
	Synchronizes with the data source. More...

Friends
InputStream &	operator>> (InputStream &is, const dataset tbl)
	set name of dataset More...
InputStream &	operator>> (InputStream &is, setpattern_key pk)
	set metadata key at which the pattern will be stored More...
InputStream &	operator>> (InputStream &is, restore_pattern rs)
	set whether pattern layout should be restored from metadata More...
InputStream &	operator>> (InputStream &is, const type_converter conv)
	custom type converter function to convert native type to HDF5 type More...
template<typename Container_t >
InputStream &	operator>> (InputStream &is, Container_t &matrix)
	kicker which loads an container using the specified stream properties. More...

Detailed Description

Definition at line 25 of file InputStream.h.

Constructor & Destructor Documentation

InputStream() [1/2]

dash::io::hdf5::InputStream::InputStream ( dash::launch  lpolicy, std::string  filename  )

inline

Creates an HDF5 input stream using a launch policy.

Support of dash::launch::async is still highly experimental and requires thread support in MPI. If multi-threaded access is not supported, blocking I/O is used as fallback. To wait for outstanding IO operations use flush(). Until the stream is not flushed, no write accesses to the container, as well as no barriers are allowed. Otherwise the behavior is undefined.

Definition at line 50 of file InputStream.h.

References dash::async, dash::is_multithreaded(), and dash::sync.

      : _filename(filename), _dataset("data"), _launch_policy(lpolicy) {
    if (_launch_policy == dash::launch::async && !dash::is_multithreaded()) {
      _launch_policy = dash::launch::sync;
      DASH_LOG_WARN(
          "Requested ASIO but DART does not support "
          "multi-threaded access. Blocking IO is used"
          "as fallback");
    }
  }

InputStream() [2/2]

dash::io::hdf5::InputStream::InputStream ( std::string  filename )

inlineexplicit

Creates an HDF5 input stream using blocking IO.

The stream takes an arbitrary number of modifiers and objects, where the objects are stored in the order of passing it to the stream.

The interface follows roughly the STL stream concept.

Example:

dash::Array<double> array_a;
dash::Array<double> array_b;

InputStream is("file.hdf5");
is >> dataset("dataset") >> array_a
   >> dataset("seconddata") >> array_b;

Definition at line 79 of file InputStream.h.

References dash::sync.

      : InputStream(dash::launch::sync, filename) {}

Member Function Documentation

flush()

InputStream& dash::io::hdf5::InputStream::flush ( )

inline

Synchronizes with the data source.

If dash::launch::async is used, waits until all data is read

Definition at line 99 of file InputStream.h.

                        {
    DASH_LOG_DEBUG("flush input stream", _async_ops.size());
    if (!_async_ops.empty()) {
      _async_ops.back().wait();
    }
    DASH_LOG_DEBUG("input stream flushed");
    return *this;
  }

Friends And Related Function Documentation

operator>> [1/5]

InputStream& operator>> ( InputStream &  is, const dataset  tbl  )

friend

set name of dataset

Definition at line 111 of file InputStream.h.

                                                                     {
    is._dataset = tbl._dataset;
    return is;
  }

operator>> [2/5]

InputStream& operator>> ( InputStream &  is, setpattern_key  pk  )

friend

set metadata key at which the pattern will be stored

Definition at line 117 of file InputStream.h.

                                                                     {
    is._foptions.pattern_metadata_key = pk._key;
    return is;
  }

operator>> [3/5]

InputStream& operator>> ( InputStream &  is, restore_pattern  rs  )

friend

set whether pattern layout should be restored from metadata

Definition at line 123 of file InputStream.h.

                                                                      {
    is._foptions.restore_pattern = rs._restore;
    return is;
  }

operator>> [4/5]

InputStream& operator>> ( InputStream &  is, const type_converter  conv  )

friend

custom type converter function to convert native type to HDF5 type

Definition at line 129 of file InputStream.h.

                                                                             {
    is._converter = conv;
    is._use_cust_conv = true;
    return is;
  }

operator>> [5/5]

template<typename Container_t >

InputStream& operator>> ( InputStream &  is, Container_t &  matrix  )

friend

kicker which loads an container using the specified stream properties.

---

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

• /tmp/tmporruphar/dash/include/dash/io/hdf5/InputStream.h