Public Member Functions | Private Attributes
ecl::OConsole Class Reference

Device for writing to standard output. More...

#include <console.hpp>

List of all members.

Public Member Functions

const Errorerror () const
 Returns the most recent error status.
void flush () ecl_assert_throw_decl(StandardException)
 Flush the internal buffer.
 OConsole ()
 Default constructor.
bool open ()
 Dummy handle to satisfy the output device concept.
long write (const char &c) ecl_assert_throw_decl(StandardException)
 Write a character to the buffer.
long write (const char *s, unsigned long n) ecl_assert_throw_decl(StandardException)
 Write a character string to the buffer.
virtual ~OConsole ()

Private Attributes

devices::CharStringBuffer buffer
Error error_handler

Detailed Description

Device for writing to standard output.

Device for writing to standard output. It creates a wrapper class around the stdout handle from cstdio to implement an ecl output device. Do not use this directly, it serves only as the device handle for the console stream classes.

Definition at line 43 of file console.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 48 of file console.hpp.

virtual ecl::OConsole::~OConsole ( ) [inline, virtual]

Definition at line 49 of file console.hpp.


Member Function Documentation

const Error& ecl::OConsole::error ( ) const [inline]

Returns the most recent error status.

Use this to check on the status of the object after a method has been called. Mostly this is here to serve as a graceful fallback for when exceptions are disabled.

Returns:

Definition at line 103 of file console.hpp.

Flush the internal buffer.

Flushes the userspace buffers to standard output.

Exceptions:
StandardException: throws if flushing returned an error [debug mode only].

Definition at line 49 of file console.cpp.

bool ecl::OConsole::open ( ) [inline]

Dummy handle to satisfy the output device concept.

For console devices this does nothing - the standard output is always open. It is just a dummy handle built to ensure the output device concept is satisfied.

Returns:
bool : always returns true (it is always open).

Definition at line 62 of file console.hpp.

long ecl::OConsole::write ( const char &  c)

Write a character to the buffer.

Write a character to the buffer. It will automatically flush if the buffer exceeds its capacity.

Parameters:
c: the character to write.
Returns:
long : the number of bytes written.
Exceptions:
StandardException: throws if writing returned an error [debug mode only].

Definition at line 28 of file console.cpp.

long ecl::OConsole::write ( const char *  s,
unsigned long  n 
)

Write a character string to the buffer.

Write a character string to the buffer. It will automatically flush if the buffer exceeds its capacity.

Parameters:
s: points to the beginning of the character string
n: the number of characters to write.
Returns:
long: the number of bytes written.
Exceptions:
StandardException: throws if flushing returned an error [debug mode only].

Definition at line 37 of file console.cpp.


Member Data Documentation

Definition at line 105 of file console.hpp.

Definition at line 106 of file console.hpp.


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


ecl_devices
Author(s): Daniel Stonier
autogenerated on Mon Jul 3 2017 02:22:02