Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Protected Member Functions | List of all members
om::io::PrintStream Class Reference

A class that allows the user to print messages/data to standard output. More...

#include <omPrintStream.h>

Inheritance diagram for om::io::PrintStream:
om::io::StringOutputStream

Public Member Functions

virtual void flush ()
 Flush the print stream, sending all internally buffered output to standard output. More...
 
- Public Member Functions inherited from om::io::StringOutputStream
 StringOutputStream ()
 Create a StringOutputStream with the native output endianness. More...
 
 StringOutputStream (data::Endianness newEndianness)
 Create a StringOutputStream with the specified output endianness. More...
 
virtual ~StringOutputStream ()
 Destroy an output stream and free all of it's resources (close it). More...
 
Bool writeASCII (Char character)
 Write one ASCII character to the output stream. More...
 
Size writeASCII (const Char *characters)
 Write characters from the buffer until a NULl terminator is reached and return the number written. More...
 
Size writeASCII (const Char *characters, Size numCharacters)
 Write the specified number of characters from the buffer and return the number written. More...
 
Size writeASCII (const data::String &string)
 Write the specified string to the output string and return the number of characters written. More...
 
Bool writeUTF8 (UTF8Char character)
 Write one UTF-8 character to the output stream. More...
 
Size writeUTF8 (const UTF8Char *characters)
 Write characters from the buffer until a NULl terminator is reached and return the number written. More...
 
Size writeUTF8 (const UTF8Char *characters, Size numCharacters)
 Write the specified number of characters from the buffer and return the number written. More...
 
Size writeUTF8 (const data::UTF8String &string)
 Write the specified string to the output string and return the number of characters written. More...
 
Bool writeUTF16 (UTF16Char character)
 Write one UTF-16 character to the output stream. More...
 
Size writeUTF16 (const UTF16Char *characters)
 Write characters from the buffer until a NULL terminator is reached and return the number written. More...
 
Size writeUTF16 (const UTF16Char *characters, Size numCharacters)
 Write the specified number of characters from the buffer and return the number written. More...
 
Size writeUTF16 (const data::UTF16String &string)
 Write the specified string to the output string and return the number of characters written. More...
 
Bool writeUTF32 (UTF32Char character)
 Write one UTF-32 character to the output stream. More...
 
Size writeUTF32 (const UTF32Char *characters)
 Write characters from the buffer until a NULl terminator is reached and return the number written. More...
 
Size writeUTF32 (const UTF32Char *characters, Size numCharacters)
 Write the specified number of characters from the buffer and return the number written. More...
 
Size writeUTF32 (const data::UTF32String &string)
 Write the specified string to the output string and return the number of characters written. More...
 
data::Endianness getEndianness () const
 Get the current endianness of the wide characters being written to the stream. More...
 
void setEndianness (data::Endianness newEndianness)
 Set the stream to write wide characters in the specified endian format. More...
 

Protected Member Functions

virtual Size writeChars (const Char *characters, Size number)
 Write the specified number of characters from the character buffer and return the number written. More...
 
virtual Size writeUTF8Chars (const UTF8Char *characters, Size number)
 Write the specified number of UTF-8 characters from the character buffer and return the number written. More...
 
virtual Size writeUTF16Chars (const UTF16Char *characters, Size number)
 Write the specified number of UTF-16 characters from the character buffer and return the number written. More...
 
virtual Size writeUTF32Chars (const UTF32Char *characters, Size number)
 Write the specified number of UTF-32 characters from the character buffer and return the number written. More...
 

Detailed Description

A class that allows the user to print messages/data to standard output.

It is a wrapper for C standard output that implements the StringOutputStream interface.

Member Function Documentation

virtual void om::io::PrintStream::flush ( )
virtual

Flush the print stream, sending all internally buffered output to standard output.

This method causes all currently pending output data to be sent to C standard output. This method ensures that this is done and that all internal data buffers are emptied if they have any contents.

Implements om::io::StringOutputStream.

virtual Size om::io::PrintStream::writeChars ( const Char characters,
Size  number 
)
protectedvirtual

Write the specified number of characters from the character buffer and return the number written.

Implements om::io::StringOutputStream.

virtual Size om::io::PrintStream::writeUTF8Chars ( const UTF8Char characters,
Size  number 
)
protectedvirtual

Write the specified number of UTF-8 characters from the character buffer and return the number written.

Implements om::io::StringOutputStream.

virtual Size om::io::PrintStream::writeUTF16Chars ( const UTF16Char characters,
Size  number 
)
protectedvirtual

Write the specified number of UTF-16 characters from the character buffer and return the number written.

Implements om::io::StringOutputStream.

virtual Size om::io::PrintStream::writeUTF32Chars ( const UTF32Char characters,
Size  number 
)
protectedvirtual

Write the specified number of UTF-32 characters from the character buffer and return the number written.

Implements om::io::StringOutputStream.


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