OutputStream Struct Reference
[I/O Services.]

Inherits Service.

Inherited by OutputStreamImpl.

List of all members.

Public Methods

virtual bool initialize (RawStream *raw, Directory *dir, const Char *name)=0
virtual unsigned write (void *buffer, unsigned num)=0
virtual bool flush ()=0
virtual void setByteOrder (int order)=0
virtual bool writeInt8 (UInt8 i)=0
virtual bool writeInt16 (UInt16 i)=0
virtual bool writeInt32 (UInt32 i)=0
virtual bool writeFloat (Float f)=0
virtual bool writeString (const Char *s)=0


Detailed Description

A write-only data stream.


Member Function Documentation

virtual bool OutputStream::flush   [pure virtual]
 

Flush any buffered output to the stream.

virtual bool OutputStream::initialize RawStream   raw,
Directory   dir,
const Char   name
[pure virtual]
 

Prepare the stream for use. Called by the I/O service as part of the stream setup code.

virtual void OutputStream::setByteOrder int    order [pure virtual]
 

Set the byte ordering for higher level data objects. The default for new streams is STREAM_LSB.

Parameters:
order  STREAM_MSB or STREAM_LSB

virtual unsigned OutputStream::write void *    buffer,
unsigned    num
[pure virtual]
 

Write raw bytes to the stream.

Parameters:
buffer  A buffer to hold the data to be written.
num  The number of bytes to write to the stream.
Returns:
The number of bytes actually written.

virtual bool OutputStream::writeFloat Float    f [pure virtual]
 

Read a single-precision floating point number.

virtual bool OutputStream::writeInt16 UInt16    i [pure virtual]
 

Write a 16-bit integer number.

virtual bool OutputStream::writeInt32 UInt32    i [pure virtual]
 

Read a 32-bit integer number.

virtual bool OutputStream::writeInt8 UInt8    i [pure virtual]
 

Write an 8-bit integer number.

virtual bool OutputStream::writeString const Char   s [pure virtual]
 

Write a string to the stream.

Scripted as:
bool writeString(string)


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


Flat Four Engine
Copyright (C) 2001 by 379, Inc.
This page generated by Doxygen