The Nebula Device 3: IO::StreamReader Class Reference

The Nebula Device 3

IO::StreamReader Class Reference

#include <streamreader.h>

Inheritance diagram for IO::StreamReader:

Core::RefCounted Http::HttpRequestReader IO::BinaryReader IO::TextReader IO::XmlReader Messaging::MessageReader Models::ModelReader Models::BinaryModelReader Models::N2ModelReader Models::XmlModelReader


Detailed Description

Stream reader classes provide a specialized read-interface for a stream. This is the abstract base class for all stream readers. It is possible to attach any number of readers and writers to the same stream.

(C) 2006 Radon Labs GmbH

Public Member Functions

 StreamReader ()
 constructor
virtual ~StreamReader ()
 destructor
void SetStream (const Ptr< Stream > &s)
 set stream to read from
const Ptr< Stream > & GetStream () const
 get currently set stream
bool HasStream () const
 return true if a stream is set
bool Eof () const
 return true if the stream has reached EOF
virtual bool Open ()
 begin reading from the stream
virtual void Close ()
 end reading from the stream
bool IsOpen () const
 return true if currently open
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

void IO::StreamReader::SetStream ( const Ptr< Stream > &  s  ) 

set stream to read from

Attaches the reader to a stream. This will imcrement the refcount of the stream.

Reimplemented in Messaging::MessageReader.

const Ptr< Stream > & IO::StreamReader::GetStream (  )  const

get currently set stream

Get pointer to the attached stream. If there is no stream attached, an assertion will be thrown. Use HasStream() to determine if a stream is attached.

bool IO::StreamReader::HasStream (  )  const

return true if a stream is set

Returns true if a stream is attached to the reader.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.