Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

rnaml::OutputStream Class Reference

#include <OutputStream.h>

Inheritance diagram for rnaml::OutputStream:

rnaml::FileOutputStream rnaml::GZIPOutputStream rnaml::PrintStream List of all members.

Public Methods

virtual ~OutputStream ()
 Destroys the object.

xmlcpgOutputStreamgetCStructure () const
 Gets the C substructure.

void setCStructure (xmlcpgOutputStream *is)
 Sets the C substructure.

virtual bool getEOS () const
 Tests the end of stream indicator of the output stream.

virtual bool getError () const
 Tests the error indicator of the output stream.

virtual const char * getErrorString () const
 Gets the string describing the error.

virtual bool flush ()
 Flushes the output stream.

virtual int write (int c)
 Writes a character to the output stream.

virtual int write (const void *ptr, int nb)
 Writes some bytes of data from the buffer ptr.

virtual bool close ()
 Closes the output stream.


Protected Methods

 OutputStream (xmlcpgOutputStream *cos)
 Initializes the output stream with a C substructure.


Protected Attributes

xmlcpgOutputStreamos
 The C sub-structure.


Detailed Description

Author:
Martin Larose (larosem@iro.umontreal.ca)
Version:
Id:
OutputStream.h,v 1.1 2003/11/10 22:58:32 larosem Exp


Constructor & Destructor Documentation

rnaml::OutputStream::OutputStream xmlcpgOutputStream   cos [inline, protected]
 

Initializes the output stream with a C substructure.

Parameters:
cos  the C output stream.

rnaml::OutputStream::~OutputStream   [virtual]
 

Destroys the object.


Member Function Documentation

bool rnaml::OutputStream::close   [virtual]
 

Closes the output stream.

Returns:
true upon successful completion, false otherwise.

bool rnaml::OutputStream::flush   [virtual]
 

Flushes the output stream.

Returns:
true on successful completion, false otherwise.

xmlcpgOutputStream* rnaml::OutputStream::getCStructure   const [inline]
 

Gets the C substructure.

Returns:
the C substructure.

bool rnaml::OutputStream::getEOS   [virtual]
 

Tests the end of stream indicator of the output stream.

Returns:
true if it is set.

bool rnaml::OutputStream::getError   [virtual]
 

Tests the error indicator of the output stream.

Returns:
true if an error occured.

const char * rnaml::OutputStream::getErrorString   [virtual]
 

Gets the string describing the error.

Returns:
the error string.

void rnaml::OutputStream::setCStructure xmlcpgOutputStream   is
 

Sets the C substructure.

Parameters:
is  the xmlcpgInputStream.

int rnaml::OutputStream::write const void *    ptr,
int    nb
[virtual]
 

Writes some bytes of data from the buffer ptr.

Parameters:
ptr  the bytes location.
nb  the number of bytes to write.
Returns:
the number of bytes written or 0 on end of stream or -1 on error.

int rnaml::OutputStream::write int    c [virtual]
 

Writes a character to the output stream.

Parameters:
c  the character to write.
Returns:
the character written as an unsigned char cast to an int or -1 on error.


Member Data Documentation

xmlcpgOutputStream* rnaml::OutputStream::os [protected]
 

The C sub-structure.


The documentation for this class was generated from the following files:
Generated on Tue Nov 11 14:59:56 2003 for xmlcpg by doxygen1.2.18