Parent class for text stream functionality. More...
#include <base_text_stream.hpp>
Public Member Functions | |
| BaseTextStream () | |
| Device & | device () |
| Provides access to the underlying output device. | |
| const ecl::Error & | errorStatus () const |
| Enumeration indicating the exit status of the last read operation. | |
| bool | fail () const |
| Denotes the status of the last device operation. | |
| virtual | ~BaseTextStream () |
Protected Attributes | |
| ecl::Error | error |
| Device | io_device |
Detailed Description
template<typename Device>
class ecl::interfaces::BaseTextStream< Device >
Parent class for text stream functionality.
This brings the common io functionality together for both input and output text streams, namely the device and its handlers.
- Template Parameters:
-
Device : the underlying device type.
Definition at line 42 of file base_text_stream.hpp.
Constructor & Destructor Documentation
| ecl::interfaces::BaseTextStream< Device >::BaseTextStream | ( | ) | [inline] |
Definition at line 44 of file base_text_stream.hpp.
| virtual ecl::interfaces::BaseTextStream< Device >::~BaseTextStream | ( | ) | [inline, virtual] |
Definition at line 45 of file base_text_stream.hpp.
Member Function Documentation
| Device & ecl::interfaces::BaseTextStream< Device >::device | ( | ) |
Provides access to the underlying output device.
Provides access to the underlying output device.
- Returns:
- Device : reference to the underlying output device.
Definition at line 65 of file base_text_stream.hpp.
| const ecl::Error & ecl::interfaces::BaseTextStream< Device >::errorStatus | ( | ) | const |
Enumeration indicating the exit status of the last read operation.
This returns an enumeration that indicates the exit status of the last read operation.
- Returns:
- ErrorFlag : the error status indicator (NoError is a valid state).
Definition at line 93 of file base_text_stream.hpp.
| bool ecl::interfaces::BaseTextStream< Device >::fail | ( | ) | const |
Denotes the status of the last device operation.
This returns true if the last (read/write) operation failed. This can be due to the input being incorrect (e.g. letters in a value when reading a digit), or because it tried to read past the end of the stream, or the stream is in a bad state. return bool : true if the last stream operation failed, false otherwise.
Definition at line 77 of file base_text_stream.hpp.
Member Data Documentation
ecl::Error ecl::interfaces::BaseTextStream< Device >::error [protected] |
Definition at line 51 of file base_text_stream.hpp.
Device ecl::interfaces::BaseTextStream< Device >::io_device [protected] |
Definition at line 52 of file base_text_stream.hpp.
The documentation for this class was generated from the following file: