AXCEL C++ Framework
Elegance through abstraction
Public Member Functions | Public Attributes
axcel::io::iob Class Reference

I/O stream base. More...

#include <axcel.h>

Inheritance diagram for axcel::io::iob:
axcel::object axcel::io::input axcel::io::output axcel::io::ios axcel::io::ios axcel::console axcel::data axcel::fs::file axcel::net::socket::tcp axcel::proc::pstream axcel::console axcel::data axcel::fs::file axcel::net::socket::tcp axcel::proc::pstream

List of all members.

Public Member Functions

virtual string type ()
 Get type of object.
virtual operator string ()
 Convert to string.
 iob ()
bool ok ()
 Is stream ok?
bool hurt ()
 Has I/O error occurred?
bool dead ()
 Is stream broken?
bool eof ()
 End of fs::file?
void heal ()
 Stream is ok.
void hit ()
 Stream is hurt.
void kill ()
 Stream is dead.
void drain ()
 Stream is at EOF.

Public Attributes

iofmt fmt

Detailed Description

I/O stream base.

Definition at line 308 of file axcel.h.


Constructor & Destructor Documentation

axcel::io::iob::iob ( ) [inline]

Definition at line 313 of file axcel.h.


Member Function Documentation

bool axcel::io::iob::dead ( )

Is stream broken?

Returns:
true if fatal error has occurred and stream can no longer be used, false if not.

Definition at line 527 of file axcel.cpp.

void axcel::io::iob::drain ( )

Stream is at EOF.

Stream has reached end of input or has filled the maximum capacity for output data. This method sets a flag for the stream so that eof() results in true.

Definition at line 560 of file axcel.cpp.

bool axcel::io::iob::eof ( )

End of fs::file?

Returns:
true if end of fs::file for the stream has been reached, that is, no more data is available to read and/or output data has reached maximum capacity.

Definition at line 533 of file axcel.cpp.

void axcel::io::iob::heal ( )

Stream is ok.

Clears eof and error indicators for stream so a call to ok() results in true

Definition at line 539 of file axcel.cpp.

void axcel::io::iob::hit ( )

Stream is hurt.

Last I/O operation has resulted in an error but the stream is still potentially usable. This method sets a flag for the stream so that hurt() results in true.

Definition at line 546 of file axcel.cpp.

bool axcel::io::iob::hurt ( )

Has I/O error occurred?

Returns:
true if last I/O operation resulted in error but the stream is still usable, false if not.

Definition at line 522 of file axcel.cpp.

void axcel::io::iob::kill ( )

Stream is dead.

Fatal I/O error has occurred and stream can no longer be used. This method sets a flag for the stream so that dead() results in true.

Definition at line 553 of file axcel.cpp.

bool axcel::io::iob::ok ( )

Is stream ok?

Returns:
true if stream is good for I/O, false if not

Definition at line 517 of file axcel.cpp.

axcel::io::iob::operator string ( ) [virtual]

Convert to string.

Returns:
Suitable string representation of object's data

Implements axcel::object.

Reimplemented in axcel::io::ios, axcel::data, axcel::string, axcel::fs::file, axcel::net::socket::tcp, axcel::console, and axcel::proc::pstream.

Definition at line 274 of file axcel.cpp.

string axcel::io::iob::type ( ) [virtual]

Get type of object.

Returns:
string containing name of object's class.

Implements axcel::object.

Reimplemented in axcel::io::input, axcel::io::output, axcel::io::ios, axcel::data, axcel::string, axcel::fs::file, axcel::net::socket::tcp, axcel::console, and axcel::proc::pstream.

Definition at line 254 of file axcel.cpp.


Member Data Documentation

Definition at line 314 of file axcel.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Defines