The Nebula Device 3: IO::ConsoleHandler Class Reference

The Nebula Device 3

IO::ConsoleHandler Class Reference

#include <consolehandler.h>

Inheritance diagram for IO::ConsoleHandler:

Core::RefCounted Win32::Win32ConsoleHandler


Detailed Description

Base class for all console handlers. Console handlers are attached to Nebula3's central console object and are notified by the console object about output and deliver input to the console.

(C) 2006 Radon Labs GmbH

Public Member Functions

 ConsoleHandler ()
 constructor
virtual ~ConsoleHandler ()
 destructor
virtual void Open ()
 called by console when attached
virtual void Close ()
 called by console when removed
bool IsOpen () const
 return true if currently open
virtual void Update ()
 called by Console::Update()
virtual void Print (const Util::String &s)
 called by console to output data
virtual void Error (const Util::String &s)
 called by console with serious error
virtual void Warning (const Util::String &s)
 called by console to output warning
virtual void DebugOut (const Util::String &s)
 called by console to output debug string
virtual bool HasInput ()
 return true if input is available
virtual Util::String GetInput ()
 read available input
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

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.