class Gambit::Printers::HDF5Reader
[No description available]
Inherits from Gambit::Printers::BaseReader, Gambit::Printers::BaseBaseReader
Public Functions
| Name | |
|---|---|
| virtual void | reset() Base class virtual interface functions. |
| virtual ulong | get_dataset_length() Get length of input dataset. |
| virtual PPIDpair | get_next_point() Get next rank/ptID pair in data file. |
| virtual PPIDpair | get_current_point() Get current rank/ptID pair in data file. |
| virtual ulong | get_current_index() |
| virtual bool | eoi() Check if ‘current point’ is past the end of the datasets (and thus invalid!) |
| virtual std::size_t | get_type(const std::string & label) |
| virtual std::set< std::string > | get_all_labels() Get labels of all datasets in the linked group. |
| template <typename T > bool | _retrieve(T & , const std::string & label, const uint, const ulong) Retrieve functions. |
| HDF5Reader(const Options & options) | |
| ~HDF5Reader() |
Additional inherited members
Public Functions inherited from Gambit::Printers::BaseReader
| Name | |
|---|---|
| BaseReader() | |
| virtual | ~BaseReader() Destructor. |
| template <typename T > bool | retrieve(T & out, const std::string & label) Reimplement overload for ‘retrieve’ that uses the current point as the input for rank/pointID. |
| template <typename T > bool | retrieve(T & out, const std::string & label, const uint rank, const ulong pointID) |
| virtual bool | retrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer, const uint rank, const ulong pointID) Retrieve and directly print data to new output. |
Public Functions inherited from Gambit::Printers::BaseBaseReader
| Name | |
|---|---|
| virtual | ~BaseBaseReader() |
| template <typename T > bool | retrieve(T & out, const std::string & label, const uint rank, const ulong pointID) |
| template <typename T > bool | retrieve(T & out, const std::string & label) Overload for ‘retrieve’ that uses the current point as the input for rank/pointID. |
| bool | retrieve_and_print(const std::string & label, BaseBasePrinter & printer, const uint rank, const ulong pointID) Retrieve and directly print data to new output. |
| virtual bool | retrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer, const uint rank, const ulong pointID) =0 |
| bool | retrieve_and_print(const std::string & label, BaseBasePrinter & printer) Overload for ‘retrieve_and_print’ that uses the current point as the input for rank/pointID. |
| bool | retrieve_and_print(const std::string & in_label, const std::string & out_label, BaseBasePrinter & printer) As above, but allows for different input/output labels. |
Public Functions Documentation
function reset
virtual void reset()
Base class virtual interface functions.
Reimplements: Gambit::Printers::BaseBaseReader::reset
Reset ‘read head’ position to first entry
function get_dataset_length
virtual ulong get_dataset_length()
Get length of input dataset.
Reimplements: Gambit::Printers::BaseBaseReader::get_dataset_length
function get_next_point
virtual PPIDpair get_next_point()
Get next rank/ptID pair in data file.
Reimplements: Gambit::Printers::BaseBaseReader::get_next_point
function get_current_point
virtual PPIDpair get_current_point()
Get current rank/ptID pair in data file.
Reimplements: Gambit::Printers::BaseBaseReader::get_current_point
function get_current_index
virtual ulong get_current_index()
Reimplements: Gambit::Printers::BaseBaseReader::get_current_index
function eoi
virtual bool eoi()
Check if ‘current point’ is past the end of the datasets (and thus invalid!)
Reimplements: Gambit::Printers::BaseBaseReader::eoi
function get_type
virtual std::size_t get_type(
const std::string & label
)
Reimplements: Gambit::Printers::BaseBaseReader::get_type
Get type information for a data entry, i.e. defines the C++ type which this should be retrieved as, not what it is necessarily literally stored as in the output.
Release HDF5 type ID number
function get_all_labels
virtual std::set< std::string > get_all_labels()
Get labels of all datasets in the linked group.
Reimplements: Gambit::Printers::BaseBaseReader::get_all_labels
function _retrieve
template <typename T >
inline bool _retrieve(
T & ,
const std::string & label,
const uint,
const ulong
)
Retrieve functions.
function HDF5Reader
HDF5Reader(
const Options & options
)
function ~HDF5Reader
~HDF5Reader()
Updated on 2023-06-26 at 21:36:52 +0000