The legacy abstract base class used for bidirectional I/O. More...
#include <Stream.hpp>
Public Member Functions | |
| CStream () | |
| Constructor. | |
| virtual | ~CStream () |
| Destructor. | |
| CString | ReadLine (TextFormat eFormat) |
| Read a line of text. | |
| void | WriteLine (const CString &str, TextFormat eFormat) |
| Write a line of text. | |
| virtual uint32 | Format () const |
| Get the stream contents format. | |
| virtual void | SetFormat (uint32 nFormat) |
| Set the stream contents format. | |
| virtual uint32 | Version () const |
| Get the stream contents version. | |
| virtual void | SetVersion (uint32 nVersion) |
| Set the stream contents version. | |
Protected Member Functions | |
| template<typename CharT > | |
| size_t | ReadLine (std::vector< CharT > &vBuffer) |
| Template helper function to read a line of text from the stream. | |
Protected Attributes | |
| uint | m_nMode |
| The read/write mode. | |
| uint32 | m_nFormat |
| The stream contents format. | |
| uint32 | m_nVersion |
| The stream contents version. | |
Detailed Description
The legacy abstract base class used for bidirectional I/O.
Constructor & Destructor Documentation
| CStream::CStream | ( | ) |
Constructor.
| CStream::~CStream | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| CString CStream::ReadLine | ( | TextFormat | eFormat | ) |
Read a line of text.
This returns the line of text without the line terminator.
| void CStream::WriteLine | ( | const CString & | str, |
| TextFormat | eFormat | ||
| ) |
Write a line of text.
This writes a line of text and appends the line terminator.
| uint32 CStream::Format | ( | ) | const [virtual] |
Get the stream contents format.
Implements WCL::IStreamBase.
| void CStream::SetFormat | ( | uint32 | nFormat | ) | [virtual] |
Set the stream contents format.
Implements WCL::IStreamBase.
| uint32 CStream::Version | ( | ) | const [virtual] |
Get the stream contents version.
Implements WCL::IStreamBase.
| void CStream::SetVersion | ( | uint32 | nVersion | ) | [virtual] |
Set the stream contents version.
Implements WCL::IStreamBase.
| size_t CStream::ReadLine | ( | std::vector< CharT > & | vBuffer | ) | [protected] |
Template helper function to read a line of text from the stream.
It returns the number of characters read.
Member Data Documentation
uint CStream::m_nMode [protected] |
The read/write mode.
uint32 CStream::m_nFormat [protected] |
The stream contents format.
uint32 CStream::m_nVersion [protected] |
The stream contents version.
The documentation for this class was generated from the following files:
